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

Diff for /mandoc/man.c between version 1.163 and 1.181

version 1.163, 2015/04/23 16:17:44 version 1.181, 2018/12/14 05:18:02
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2013,2014,2015,2017,2018 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>   * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
Line 35 
Line 35 
 #include "roff_int.h"  #include "roff_int.h"
 #include "libman.h"  #include "libman.h"
   
 const   char *const __man_macronames[MAN_MAX] = {  static  char            *man_hasc(char *);
         "br",           "TH",           "SH",           "SS",  
         "TP",           "LP",           "PP",           "P",  
         "IP",           "HP",           "SM",           "SB",  
         "BI",           "IB",           "BR",           "RB",  
         "R",            "B",            "I",            "IR",  
         "RI",           "sp",           "nf",  
         "fi",           "RE",           "RS",           "DT",  
         "UC",           "PD",           "AT",           "in",  
         "ft",           "OP",           "EX",           "EE",  
         "UR",           "UE",           "ll"  
         };  
   
 const   char * const *man_macronames = __man_macronames;  
   
 static  void             man_descope(struct roff_man *, int, int);  
 static  int              man_ptext(struct roff_man *, int, char *, int);  static  int              man_ptext(struct roff_man *, int, char *, int);
 static  int              man_pmacro(struct roff_man *, int, char *, int);  static  int              man_pmacro(struct roff_man *, int, char *, int);
   
Line 62  man_parseln(struct roff_man *man, int ln, char *buf, i
Line 47  man_parseln(struct roff_man *man, int ln, char *buf, i
         if (man->last->type != ROFFT_EQN || ln > man->last->line)          if (man->last->type != ROFFT_EQN || ln > man->last->line)
                 man->flags |= MAN_NEWLINE;                  man->flags |= MAN_NEWLINE;
   
         return (roff_getcontrol(man->roff, buf, &offs) ?          return roff_getcontrol(man->roff, buf, &offs) ?
             man_pmacro(man, ln, buf, offs) :              man_pmacro(man, ln, buf, offs) :
             man_ptext(man, ln, buf, offs));              man_ptext(man, ln, buf, offs);
 }  }
   
 static void  /*
 man_descope(struct roff_man *man, int line, int offs)   * If the string ends with \c, return a pointer to the backslash.
    * Otherwise, return NULL.
    */
   static char *
   man_hasc(char *start)
 {  {
           char    *cp, *ep;
   
           ep = strchr(start, '\0') - 2;
           if (ep < start || ep[0] != '\\' || ep[1] != 'c')
                   return NULL;
           for (cp = ep; cp > start; cp--)
                   if (cp[-1] != '\\')
                           break;
           return (ep - cp) % 2 ? NULL : ep;
   }
   
   void
   man_descope(struct roff_man *man, int line, int offs, char *start)
   {
           /* Trailing \c keeps next-line scope open. */
   
           if (start != NULL && man_hasc(start) != NULL)
                   return;
   
         /*          /*
          * Co-ordinate what happens with having a next-line scope open:           * Co-ordinate what happens with having a next-line scope open:
          * first close out the element scope (if applicable), then close           * first close out the element scopes (if applicable),
          * out the block scope (also if applicable).           * then close out the block scope (also if applicable).
          */           */
   
         if (man->flags & MAN_ELINE) {          if (man->flags & MAN_ELINE) {
                   while (man->last->parent->type != ROFFT_ROOT &&
                       man_macro(man->last->parent->tok)->flags & MAN_ESCOPED)
                           man_unscope(man, man->last->parent);
                 man->flags &= ~MAN_ELINE;                  man->flags &= ~MAN_ELINE;
                 man_unscope(man, man->last->parent);  
         }          }
         if ( ! (man->flags & MAN_BLINE))          if ( ! (man->flags & MAN_BLINE))
                 return;                  return;
Line 91  static int
Line 101  static int
 man_ptext(struct roff_man *man, int line, char *buf, int offs)  man_ptext(struct roff_man *man, int line, char *buf, int offs)
 {  {
         int              i;          int              i;
           char            *ep;
   
         /* Literal free-form text whitespace is preserved. */          /* Literal free-form text whitespace is preserved. */
   
         if (man->flags & MAN_LITERAL) {          if (man->flags & MAN_LITERAL) {
                 roff_word_alloc(man, line, offs, buf + offs);                  roff_word_alloc(man, line, offs, buf + offs);
                 man_descope(man, line, offs);                  man_descope(man, line, offs, buf + offs);
                 return(1);                  return 1;
         }          }
   
         for (i = offs; buf[i] == ' '; i++)          for (i = offs; buf[i] == ' '; i++)
                 /* Skip leading whitespace. */ ;                  /* Skip leading whitespace. */ ;
   
         /*          /*
          * Blank lines are ignored right after headings           * Blank lines are ignored in next line scope
            * and right after headings and cancel preceding \c,
          * but add a single vertical space elsewhere.           * but add a single vertical space elsewhere.
          */           */
   
         if (buf[i] == '\0') {          if (buf[i] == '\0') {
                 /* Allocate a blank entry. */                  if (man->flags & (MAN_ELINE | MAN_BLINE)) {
                 if (man->last->tok != MAN_SH &&                          mandoc_msg(MANDOCERR_BLK_BLANK, line, 0, NULL);
                     man->last->tok != MAN_SS) {                          return 1;
                         roff_elem_alloc(man, line, offs, MAN_sp);  
                         man->next = ROFF_NEXT_SIBLING;  
                 }                  }
                 return(1);                  if (man->last->tok == MAN_SH || man->last->tok == MAN_SS)
                           return 1;
                   if (man->last->type == ROFFT_TEXT &&
                       ((ep = man_hasc(man->last->string)) != NULL)) {
                           *ep = '\0';
                           return 1;
                   }
                   roff_elem_alloc(man, line, offs, ROFF_sp);
                   man->next = ROFF_NEXT_SIBLING;
                   return 1;
         }          }
   
         /*          /*
Line 128  man_ptext(struct roff_man *man, int line, char *buf, i
Line 147  man_ptext(struct roff_man *man, int line, char *buf, i
   
         if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {          if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                 if (i > 1 && '\\' != buf[i - 2])                  if (i > 1 && '\\' != buf[i - 2])
                         mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,                          mandoc_msg(MANDOCERR_SPACE_EOL, line, i - 1, NULL);
                             line, i - 1, NULL);  
   
                 for (--i; i && ' ' == buf[i]; i--)                  for (--i; i && ' ' == buf[i]; i--)
                         /* Spin back to non-space. */ ;                          /* Spin back to non-space. */ ;
Line 149  man_ptext(struct roff_man *man, int line, char *buf, i
Line 167  man_ptext(struct roff_man *man, int line, char *buf, i
   
         assert(i);          assert(i);
         if (mandoc_eos(buf, (size_t)i))          if (mandoc_eos(buf, (size_t)i))
                 man->last->flags |= MAN_EOS;                  man->last->flags |= NODE_EOS;
   
         man_descope(man, line, offs);          man_descope(man, line, offs, buf + offs);
         return(1);          return 1;
 }  }
   
 static int  static int
Line 160  man_pmacro(struct roff_man *man, int ln, char *buf, in
Line 178  man_pmacro(struct roff_man *man, int ln, char *buf, in
 {  {
         struct roff_node *n;          struct roff_node *n;
         const char      *cp;          const char      *cp;
         int              tok;          size_t           sz;
         int              i, ppos;          enum roff_tok    tok;
           int              ppos;
         int              bline;          int              bline;
         char             mac[5];  
   
         ppos = offs;          /* Determine the line macro. */
   
         /*          ppos = offs;
          * Copy the first word into a nil-terminated buffer.          tok = TOKEN_NONE;
          * Stop when a space, tab, escape, or eoln is encountered.          for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
          */                  offs++;
           if (sz > 0 && sz < 4)
         i = 0;                  tok = roffhash_find(man->manmac, buf + ppos, sz);
         while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)  
                 mac[i++] = buf[offs++];  
   
         mac[i] = '\0';  
   
         tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE;  
   
         if (tok == TOKEN_NONE) {          if (tok == TOKEN_NONE) {
                 mandoc_msg(MANDOCERR_MACRO, man->parse,                  mandoc_msg(MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1);
                     ln, ppos, buf + ppos - 1);                  return 1;
                 return(1);  
         }          }
   
         /* Skip a leading escape sequence or tab. */          /* Skip a leading escape sequence or tab. */
Line 203  man_pmacro(struct roff_man *man, int ln, char *buf, in
Line 213  man_pmacro(struct roff_man *man, int ln, char *buf, in
   
         /* Jump to the next non-whitespace word. */          /* Jump to the next non-whitespace word. */
   
         while (buf[offs] && buf[offs] == ' ')          while (buf[offs] == ' ')
                 offs++;                  offs++;
   
         /*          /*
Line 212  man_pmacro(struct roff_man *man, int ln, char *buf, in
Line 222  man_pmacro(struct roff_man *man, int ln, char *buf, in
          */           */
   
         if (buf[offs] == '\0' && buf[offs - 1] == ' ')          if (buf[offs] == '\0' && buf[offs - 1] == ' ')
                 mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,                  mandoc_msg(MANDOCERR_SPACE_EOL, ln, offs - 1, NULL);
                     ln, offs - 1, NULL);  
   
         /*          /*
          * Some macros break next-line scopes; otherwise, remember           * Some macros break next-line scopes; otherwise, remember
Line 223  man_pmacro(struct roff_man *man, int ln, char *buf, in
Line 232  man_pmacro(struct roff_man *man, int ln, char *buf, in
         man_breakscope(man, tok);          man_breakscope(man, tok);
         bline = man->flags & MAN_BLINE;          bline = man->flags & MAN_BLINE;
   
           /*
            * If the line in next-line scope ends with \c, keep the
            * next-line scope open for the subsequent input line.
            * That is not at all portable, only groff >= 1.22.4
            * does it, but *if* this weird idiom occurs in a manual
            * page, that's very likely what the author intended.
            */
   
           if (bline && man_hasc(buf + offs))
                   bline = 0;
   
         /* Call to handler... */          /* Call to handler... */
   
         assert(man_macros[tok].fp);          (*man_macro(tok)->fp)(man, tok, ln, ppos, &offs, buf);
         (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);  
   
         /* In quick mode (for mandocdb), abort after the NAME section. */          /* In quick mode (for mandocdb), abort after the NAME section. */
   
Line 234  man_pmacro(struct roff_man *man, int ln, char *buf, in
Line 253  man_pmacro(struct roff_man *man, int ln, char *buf, in
                 n = man->last;                  n = man->last;
                 if (n->type == ROFFT_BODY &&                  if (n->type == ROFFT_BODY &&
                     strcmp(n->prev->child->string, "NAME"))                      strcmp(n->prev->child->string, "NAME"))
                         return(2);                          return 2;
         }          }
   
         /*          /*
Line 243  man_pmacro(struct roff_man *man, int ln, char *buf, in
Line 262  man_pmacro(struct roff_man *man, int ln, char *buf, in
          * unless the next-line scope is allowed to continue.           * unless the next-line scope is allowed to continue.
          */           */
   
         if ( ! bline || man->flags & MAN_ELINE ||          if (bline == 0 ||
             man_macros[tok].flags & MAN_NSCOPED)              (man->flags & MAN_BLINE) == 0 ||
                 return(1);              man->flags & MAN_ELINE ||
               man_macro(tok)->flags & MAN_NSCOPED)
                   return 1;
   
         assert(man->flags & MAN_BLINE);  
         man->flags &= ~MAN_BLINE;          man->flags &= ~MAN_BLINE;
   
         man_unscope(man, man->last->parent);          man_unscope(man, man->last->parent);
         roff_body_alloc(man, ln, ppos, man->last->tok);          roff_body_alloc(man, ln, ppos, man->last->tok);
         return(1);          return 1;
 }  }
   
 void  void
Line 266  man_breakscope(struct roff_man *man, int tok)
Line 285  man_breakscope(struct roff_man *man, int tok)
          * Delete the element that is being broken.           * Delete the element that is being broken.
          */           */
   
         if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||          if (man->flags & MAN_ELINE && (tok < MAN_TH ||
             ! (man_macros[tok].flags & MAN_NSCOPED))) {              (man_macro(tok)->flags & MAN_NSCOPED) == 0)) {
                 n = man->last;                  n = man->last;
                 assert(n->type != ROFFT_TEXT);                  if (n->type == ROFFT_TEXT)
                 if (man_macros[n->tok].flags & MAN_NSCOPED)  
                         n = n->parent;                          n = n->parent;
                   if (n->tok < MAN_TH ||
                       (man_macro(n->tok)->flags & (MAN_NSCOPED | MAN_ESCOPED))
                        == MAN_NSCOPED)
                           n = n->parent;
   
                 mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,                  mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos,
                     n->line, n->pos, "%s breaks %s",                      "%s breaks %s", roff_name[tok], roff_name[n->tok]);
                     tok == TOKEN_NONE ? "TS" : man_macronames[tok],  
                     man_macronames[n->tok]);  
   
                 roff_node_delete(man, n);                  roff_node_delete(man, n);
                 man->flags &= ~MAN_ELINE;                  man->flags &= ~MAN_ELINE;
         }          }
   
         /*          /*
            * Weird special case:
            * Switching fill mode closes section headers.
            */
   
           if (man->flags & MAN_BLINE &&
               (tok == MAN_nf || tok == MAN_fi) &&
               (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
                   n = man->last;
                   man_unscope(man, n);
                   roff_body_alloc(man, n->line, n->pos, n->tok);
                   man->flags &= ~MAN_BLINE;
           }
   
           /*
          * A block header next line scope is open,           * A block header next line scope is open,
          * and the new macro is not allowed inside block headers.           * and the new macro is not allowed inside block headers.
          * Delete the block that is being broken.           * Delete the block that is being broken.
          */           */
   
         if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||          if (man->flags & MAN_BLINE && (tok < MAN_TH ||
             man_macros[tok].flags & MAN_BSCOPE)) {              man_macro(tok)->flags & MAN_XSCOPE)) {
                 n = man->last;                  n = man->last;
                 if (n->type == ROFFT_TEXT)                  if (n->type == ROFFT_TEXT)
                         n = n->parent;                          n = n->parent;
                 if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))                  if (n->tok < MAN_TH ||
                       (man_macro(n->tok)->flags & MAN_XSCOPE) == 0)
                         n = n->parent;                          n = n->parent;
   
                 assert(n->type == ROFFT_HEAD);                  assert(n->type == ROFFT_HEAD);
                 n = n->parent;                  n = n->parent;
                 assert(n->type == ROFFT_BLOCK);                  assert(n->type == ROFFT_BLOCK);
                 assert(man_macros[n->tok].flags & MAN_SCOPED);                  assert(man_macro(n->tok)->flags & MAN_BSCOPED);
   
                 mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,                  mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos,
                     n->line, n->pos, "%s breaks %s",                      "%s breaks %s", roff_name[tok], roff_name[n->tok]);
                     tok == TOKEN_NONE ? "TS" : man_macronames[tok],  
                     man_macronames[n->tok]);  
   
                 roff_node_delete(man, n);                  roff_node_delete(man, n);
                 man->flags &= ~MAN_BLINE;                  man->flags &= ~MAN_BLINE;
         }          }
 }  }
   
 const struct mparse *  void
 man_mparse(const struct roff_man *man)  man_state(struct roff_man *man, struct roff_node *n)
 {  {
   
         assert(man && man->parse);          switch(n->tok) {
         return(man->parse);          case MAN_nf:
           case MAN_EX:
                   if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
                           mandoc_msg(MANDOCERR_NF_SKIP, n->line, n->pos, "nf");
                   man->flags |= MAN_LITERAL;
                   break;
           case MAN_fi:
           case MAN_EE:
                   if ( ! (man->flags & MAN_LITERAL) &&
                        ! (n->flags & NODE_VALID))
                           mandoc_msg(MANDOCERR_FI_SKIP, n->line, n->pos, "fi");
                   man->flags &= ~MAN_LITERAL;
                   break;
           default:
                   break;
           }
           man->last->flags |= NODE_VALID;
   }
   
   void
   man_validate(struct roff_man *man)
   {
   
           man->last = man->first;
           man_node_validate(man);
           man->flags &= ~MAN_LITERAL;
 }  }
Legend:
Removed from v.1.163  
changed lines
  Added in v.1.181
CVSweb