[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.14 and 1.135

version 1.14, 2009/04/12 19:45:26 version 1.135, 2018/12/14 05:18:02
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2012-2015, 2017, 2018 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
  * 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 <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   
   #include "mandoc.h"
   #include "roff.h"
   #include "man.h"
   #include "libmandoc.h"
   #include "roff_int.h"
 #include "libman.h"  #include "libman.h"
   
 #define FL_NLINE        (1 << 0)  static  void             blk_close(MACRO_PROT_ARGS);
 #define FL_TLINE        (1 << 1)  static  void             blk_exp(MACRO_PROT_ARGS);
   static  void             blk_imp(MACRO_PROT_ARGS);
 static  int              man_args(struct man *, int,  static  void             in_line_eoln(MACRO_PROT_ARGS);
   static  int              man_args(struct roff_man *, int,
                                 int *, char *, char **);                                  int *, char *, char **);
   static  void             rew_scope(struct roff_man *, enum roff_tok);
   
 static  int man_flags[MAN_MAX] = {  static const struct man_macro man_macros[MAN_MAX - MAN_TH] = {
         0, /* __ */          { in_line_eoln, MAN_XSCOPE }, /* TH */
         0, /* TH */          { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SH */
         0, /* SH */          { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SS */
         0, /* SS */          { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TP */
         FL_TLINE, /* TP */          { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TQ */
         0, /* LP */          { blk_imp, MAN_XSCOPE }, /* LP */
         0, /* PP */          { blk_imp, MAN_XSCOPE }, /* PP */
         0, /* P */          { blk_imp, MAN_XSCOPE }, /* P */
         0, /* IP */          { blk_imp, MAN_XSCOPE }, /* IP */
         0, /* HP */          { blk_imp, MAN_XSCOPE }, /* HP */
         FL_NLINE, /* SM */          { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SM */
         FL_NLINE, /* SB */          { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SB */
         FL_NLINE, /* BI */          { in_line_eoln, 0 }, /* BI */
         FL_NLINE, /* IB */          { in_line_eoln, 0 }, /* IB */
         FL_NLINE, /* BR */          { in_line_eoln, 0 }, /* BR */
         FL_NLINE, /* RB */          { in_line_eoln, 0 }, /* RB */
         FL_NLINE, /* R */          { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* R */
         FL_NLINE, /* B */          { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* B */
         FL_NLINE, /* I */          { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* I */
         FL_NLINE, /* IR */          { in_line_eoln, 0 }, /* IR */
         FL_NLINE, /* RI */          { in_line_eoln, 0 }, /* RI */
         0, /* br */          { in_line_eoln, MAN_NSCOPED }, /* nf */
         0, /* na */          { in_line_eoln, MAN_NSCOPED }, /* fi */
         FL_NLINE, /* i */          { blk_close, MAN_XSCOPE }, /* RE */
           { blk_exp, MAN_XSCOPE }, /* RS */
           { in_line_eoln, 0 }, /* DT */
           { in_line_eoln, 0 }, /* UC */
           { in_line_eoln, MAN_NSCOPED }, /* PD */
           { in_line_eoln, 0 }, /* AT */
           { in_line_eoln, MAN_NSCOPED }, /* in */
           { blk_imp, MAN_XSCOPE }, /* SY */
           { blk_close, MAN_XSCOPE }, /* YS */
           { in_line_eoln, 0 }, /* OP */
           { in_line_eoln, MAN_XSCOPE }, /* EX */
           { in_line_eoln, MAN_XSCOPE }, /* EE */
           { blk_exp, MAN_XSCOPE }, /* UR */
           { blk_close, MAN_XSCOPE }, /* UE */
           { blk_exp, MAN_XSCOPE }, /* MT */
           { blk_close, MAN_XSCOPE }, /* ME */
 };  };
   
 int  
 man_macro(struct man *man, int tok, int line,  const struct man_macro *
                 int ppos, int *pos, char *buf)  man_macro(enum roff_tok tok)
 {  {
         int              w, la;          assert(tok >= MAN_TH && tok <= MAN_MAX);
         char            *p;          return man_macros + (tok - MAN_TH);
         struct man_node *n;  }
   
         if ( ! man_elem_alloc(man, line, ppos, tok))  void
                 return(0);  man_unscope(struct roff_man *man, const struct roff_node *to)
   {
           struct roff_node *n;
   
           to = to->parent;
         n = man->last;          n = man->last;
         man->next = MAN_NEXT_CHILD;          while (n != to) {
   
         for (;;) {                  /* Reached the end of the document? */
                 la = *pos;  
                 w = man_args(man, line, pos, buf, &p);  
   
                 if (-1 == w)                  if (to == NULL && ! (n->flags & NODE_VALID)) {
                         return(0);                          if (man->flags & (MAN_BLINE | MAN_ELINE) &&
                 if (0 == w)                              man_macro(n->tok)->flags &
                         break;                               (MAN_BSCOPED | MAN_NSCOPED)) {
                                   mandoc_msg(MANDOCERR_BLK_LINE,
                                       n->line, n->pos,
                                       "EOF breaks %s", roff_name[n->tok]);
                                   if (man->flags & MAN_ELINE)
                                           man->flags &= ~MAN_ELINE;
                                   else {
                                           assert(n->type == ROFFT_HEAD);
                                           n = n->parent;
                                           man->flags &= ~MAN_BLINE;
                                   }
                                   man->last = n;
                                   n = n->parent;
                                   roff_node_delete(man, man->last);
                                   continue;
                           }
                           if (n->type == ROFFT_BLOCK &&
                               man_macro(n->tok)->fp == blk_exp)
                                   mandoc_msg(MANDOCERR_BLK_NOEND,
                                       n->line, n->pos, "%s",
                                       roff_name[n->tok]);
                   }
   
                 if ( ! man_word_alloc(man, line, la, p))                  /*
                         return(0);                   * We might delete the man->last node
                 man->next = MAN_NEXT_SIBLING;                   * in the post-validation phase.
         }                   * Save a pointer to the parent such that
                    * we know where to continue the iteration.
                    */
   
         if (n == man->last && (FL_NLINE & man_flags[tok])) {                  man->last = n;
                 if (MAN_NLINE & man->flags)                  n = n->parent;
                         return(man_verr(man, line, ppos,                  man->last->flags |= NODE_VALID;
                                 "next-line scope already open"));  
                 man->flags |= MAN_NLINE;  
                 return(1);  
         }          }
   
         if (FL_TLINE & man_flags[tok]) {  
                 if (MAN_NLINE & man->flags)  
                         return(man_verr(man, line, ppos,  
                                 "next-line scope already open"));  
                 man->flags |= MAN_NLINE;  
                 return(1);  
         }  
   
         /*          /*
          * Note that when TH is pruned, we'll be back at the root, so           * If we ended up at the parent of the node we were
          * make sure that we don't clobber as its sibling.           * supposed to rewind to, that means the target node
            * got deleted, so add the next node we parse as a child
            * of the parent instead of as a sibling of the target.
          */           */
   
         for ( ; man->last; man->last = man->last->parent) {          man->next = (man->last == to) ?
                 if (man->last == n)              ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
   }
   
   /*
    * Rewinding entails ascending the parse tree until a coherent point,
    * for example, the `SH' macro will close out any intervening `SS'
    * scopes.  When a scope is closed, it must be validated and actioned.
    */
   static void
   rew_scope(struct roff_man *man, enum roff_tok tok)
   {
           struct roff_node *n;
   
           /* Preserve empty paragraphs before RS. */
   
           n = man->last;
           if (tok == MAN_RS && n->child == NULL &&
               (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
                   return;
   
           for (;;) {
                   if (n->type == ROFFT_ROOT)
                           return;
                   if (n->flags & NODE_VALID) {
                           n = n->parent;
                           continue;
                   }
                   if (n->type != ROFFT_BLOCK) {
                           if (n->parent->type == ROFFT_ROOT) {
                                   man_unscope(man, n);
                                   return;
                           } else {
                                   n = n->parent;
                                   continue;
                           }
                   }
                   if (tok != MAN_SH && (n->tok == MAN_SH ||
                       (tok != MAN_SS && (n->tok == MAN_SS ||
                        man_macro(n->tok)->fp == blk_exp))))
                           return;
                   man_unscope(man, n);
                   n = man->last;
           }
   }
   
   
   /*
    * Close out a generic explicit macro.
    */
   void
   blk_close(MACRO_PROT_ARGS)
   {
           enum roff_tok            ctok, ntok;
           const struct roff_node  *nn;
           char                    *p;
           int                      cline, cpos, nrew, target;
   
           nrew = 1;
           switch (tok) {
           case MAN_RE:
                   ntok = MAN_RS;
                   if ( ! man_args(man, line, pos, buf, &p))
                         break;                          break;
                 if (man->last->type == MAN_ROOT)                  for (nn = man->last->parent; nn; nn = nn->parent)
                           if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
                                   nrew++;
                   target = strtol(p, &p, 10);
                   if (*p != '\0')
                           mandoc_msg(MANDOCERR_ARG_EXCESS, line,
                               (int)(p - buf), "RE ... %s", p);
                   if (target == 0)
                           target = 1;
                   nrew -= target;
                   if (nrew < 1) {
                           mandoc_msg(MANDOCERR_RE_NOTOPEN,
                               line, ppos, "RE %d", target);
                           return;
                   }
                   break;
           case MAN_YS:
                   ntok = MAN_SY;
                   break;
           case MAN_UE:
                   ntok = MAN_UR;
                   break;
           case MAN_ME:
                   ntok = MAN_MT;
                   break;
           default:
                   abort();
           }
   
           for (nn = man->last->parent; nn; nn = nn->parent)
                   if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
                         break;                          break;
                 if ( ! man_valid_post(man))  
                         return(0);          if (nn == NULL) {
                 if ( ! man_action_post(man))                  mandoc_msg(MANDOCERR_BLK_NOTOPEN,
                         return(0);                      line, ppos, "%s", roff_name[tok]);
                   rew_scope(man, MAN_PP);
                   if (tok == MAN_RE) {
                           roff_elem_alloc(man, line, ppos, ROFF_br);
                           man->last->flags |= NODE_LINE |
                               NODE_VALID | NODE_ENDED;
                           man->next = ROFF_NEXT_SIBLING;
                   }
                   return;
         }          }
   
         assert(man->last);          cline = man->last->line;
           cpos = man->last->pos;
           ctok = man->last->tok;
           man_unscope(man, nn);
   
         /*          if (tok == MAN_RE && nn->head->aux > 0)
          * Same here regarding whether we're back at the root.                  roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
          */  
   
         if (man->last->type != MAN_ROOT && ! man_valid_post(man))          /* Trailing text. */
                 return(0);  
         if (man->last->type != MAN_ROOT && ! man_action_post(man))  
                 return(0);  
         if (man->last->type != MAN_ROOT)  
                 man->next = MAN_NEXT_SIBLING;  
   
         return(1);          if (buf[*pos] != '\0') {
 }                  roff_word_alloc(man, line, ppos, buf + *pos);
                   man->last->flags |= NODE_DELIMC;
                   if (mandoc_eos(man->last->string, strlen(man->last->string)))
                           man->last->flags |= NODE_EOS;
           }
   
           /* Move a trailing paragraph behind the block. */
   
 int          if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
 man_macroend(struct man *m)                  *pos = strlen(buf);
                   blk_imp(man, ctok, cline, cpos, pos, buf);
           }
   
           /* Synopsis blocks need an explicit end marker for spacing. */
   
           if (tok == MAN_YS && man->last == nn) {
                   roff_elem_alloc(man, line, ppos, tok);
                   man_unscope(man, man->last);
           }
   }
   
   void
   blk_exp(MACRO_PROT_ARGS)
 {  {
           struct roff_node *head;
           char            *p;
           int              la;
   
         for ( ; m->last && m->last != m->first;          if (tok == MAN_RS)
                         m->last = m->last->parent) {                  rew_scope(man, tok);
                 if ( ! man_valid_post(m))          roff_block_alloc(man, line, ppos, tok);
                         return(0);          head = roff_head_alloc(man, line, ppos, tok);
                 if ( ! man_action_post(m))  
                         return(0);          la = *pos;
           if (man_args(man, line, pos, buf, &p)) {
                   roff_word_alloc(man, line, la, p);
                   if (tok == MAN_RS) {
                           if (roff_getreg(man->roff, "an-margin") == 0)
                                   roff_setreg(man->roff, "an-margin",
                                       7 * 24, '=');
                           if ((head->aux = strtod(p, NULL) * 24.0) > 0)
                                   roff_setreg(man->roff, "an-margin",
                                       head->aux, '+');
                   }
         }          }
         assert(m->last == m->first);  
   
         if ( ! man_valid_post(m))          if (buf[*pos] != '\0')
                 return(0);                  mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
         if ( ! man_action_post(m))                      "%s ... %s", roff_name[tok], buf + *pos);
                 return(0);  
   
         return(1);          man_unscope(man, head);
           roff_body_alloc(man, line, ppos, tok);
 }  }
   
   /*
 /* ARGSUSED */   * Parse an implicit-block macro.  These contain a ROFFT_HEAD and a
 static int   * ROFFT_BODY contained within a ROFFT_BLOCK.  Rules for closing out other
 man_args(struct man *m, int line,   * scopes, such as `SH' closing out an `SS', are defined in the rew
                 int *pos, char *buf, char **v)   * routines.
    */
   void
   blk_imp(MACRO_PROT_ARGS)
 {  {
           int              la;
           char            *p;
           struct roff_node *n;
   
         if (0 == buf[*pos])          rew_scope(man, tok);
                 return(0);          n = roff_block_alloc(man, line, ppos, tok);
           if (n->tok == MAN_SH || n->tok == MAN_SS)
                   man->flags &= ~MAN_LITERAL;
           n = roff_head_alloc(man, line, ppos, tok);
   
         /* First parse non-quoted strings. */          /* Add line arguments. */
   
         if ('\"' != buf[*pos]) {          for (;;) {
                 *v = &buf[*pos];                  la = *pos;
                   if ( ! man_args(man, line, pos, buf, &p))
                           break;
                   roff_word_alloc(man, line, la, p);
           }
   
                 while (buf[*pos]) {          /*
                         if (' ' == buf[*pos])           * For macros having optional next-line scope,
                                 if ('\\' != buf[*pos - 1])           * keep the head open if there were no arguments.
                                         break;           * For `TP' and `TQ', always keep the head open.
                         (*pos)++;           */
                 }  
   
                 if (0 == buf[*pos])          if (man_macro(tok)->flags & MAN_BSCOPED &&
                         return(1);              (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
                   man->flags |= MAN_BLINE;
                   return;
           }
   
                 buf[(*pos)++] = 0;          /* Close out the head and open the body. */
   
                 if (0 == buf[*pos])          man_unscope(man, n);
                         return(1);          roff_body_alloc(man, line, ppos, tok);
   }
   
                 while (buf[*pos] && ' ' == buf[*pos])  void
                         (*pos)++;  in_line_eoln(MACRO_PROT_ARGS)
   {
           int              la;
           char            *p;
           struct roff_node *n;
   
                 if (buf[*pos])          roff_elem_alloc(man, line, ppos, tok);
                         return(1);          n = man->last;
   
                 if ( ! man_vwarn(m, line, *pos, "trailing spaces"))          for (;;) {
                         return(-1);                  if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
                           mandoc_msg(MANDOCERR_ARG_SKIP, line, *pos,
                 return(1);                              "%s %s", roff_name[tok], buf + *pos);
                           break;
                   }
                   if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
                           mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
                               "%s ... %s", roff_name[tok], buf + *pos);
                           break;
                   }
                   la = *pos;
                   if ( ! man_args(man, line, pos, buf, &p))
                           break;
                   if (man_macro(tok)->flags & MAN_JOIN &&
                       man->last->type == ROFFT_TEXT)
                           roff_word_append(man, p);
                   else
                           roff_word_alloc(man, line, la, p);
         }          }
   
         /*          /*
          * If we're a quoted string (and quoted strings are allowed),           * Append NODE_EOS in case the last snipped argument
          * then parse ahead to the next quote.  If none's found, it's an           * ends with a dot, e.g. `.IR syslog (3).'
          * error.  After, parse to the next word.  
          */           */
   
         *v = &buf[++(*pos)];          if (n != man->last &&
               mandoc_eos(man->last->string, strlen(man->last->string)))
                   man->last->flags |= NODE_EOS;
   
         while (buf[*pos] && '\"' != buf[*pos])          /*
                 (*pos)++;           * If no arguments are specified and this is MAN_ESCOPED (i.e.,
            * next-line scoped), then set our mode to indicate that we're
            * waiting for terms to load into our context.
            */
   
         if (0 == buf[*pos]) {          if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) {
                 if ( ! man_vwarn(m, line, *pos, "unterminated quote"))                  man->flags |= MAN_ELINE;
                         return(-1);                  return;
                 return(1);  
         }          }
   
         buf[(*pos)++] = 0;          assert(man->last->type != ROFFT_ROOT);
         if (0 == buf[*pos])          man->next = ROFF_NEXT_SIBLING;
                 return(1);  
   
         while (buf[*pos] && ' ' == buf[*pos])          /* Rewind our element scope. */
                 (*pos)++;  
   
         if (buf[*pos])          for ( ; man->last; man->last = man->last->parent) {
                 return(1);                  man_state(man, man->last);
                   if (man->last == n)
                           break;
           }
   
         if ( ! man_vwarn(m, line, *pos, "trailing spaces"))          /* Rewind next-line scoped ancestors, if any. */
                 return(-1);  
         return(1);          if (man_macro(tok)->flags & MAN_ESCOPED)
                   man_descope(man, line, ppos, NULL);
   }
   
   void
   man_endparse(struct roff_man *man)
   {
   
           man_unscope(man, man->first);
           man->flags &= ~MAN_LITERAL;
   }
   
   static int
   man_args(struct roff_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.14  
changed lines
  Added in v.1.135
CVSweb