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

Diff for /mandoc/man_term.c between version 1.1 and 1.18

version 1.1, 2009/03/26 14:38:11 version 1.18, 2009/08/10 10:09:51
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *   *
  * 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
 #include <assert.h>  #include <assert.h>
   #include <ctype.h>
 #include <err.h>  #include <err.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
Line 25 
Line 24 
 #include "term.h"  #include "term.h"
 #include "man.h"  #include "man.h"
   
   #define INDENT            7
   #define HALFINDENT        3
   
   #ifdef __linux__
   extern  size_t            strlcpy(char *, const char *, size_t);
   extern  size_t            strlcat(char *, const char *, size_t);
   #endif
   
 #define DECL_ARGS         struct termp *p, \  #define DECL_ARGS         struct termp *p, \
                           const struct man_node *n, \                            const struct man_node *n, \
                           const struct man_meta *m                            const struct man_meta *m
Line 35  struct termact {
Line 42  struct termact {
 };  };
   
 static  int               pre_B(DECL_ARGS);  static  int               pre_B(DECL_ARGS);
   static  int               pre_BI(DECL_ARGS);
   static  int               pre_BR(DECL_ARGS);
   static  int               pre_br(DECL_ARGS);
 static  int               pre_I(DECL_ARGS);  static  int               pre_I(DECL_ARGS);
   static  int               pre_IB(DECL_ARGS);
   static  int               pre_IP(DECL_ARGS);
   static  int               pre_IR(DECL_ARGS);
 static  int               pre_PP(DECL_ARGS);  static  int               pre_PP(DECL_ARGS);
   static  int               pre_RB(DECL_ARGS);
   static  int               pre_RI(DECL_ARGS);
 static  int               pre_SH(DECL_ARGS);  static  int               pre_SH(DECL_ARGS);
 static  int               pre_SS(DECL_ARGS);  static  int               pre_SS(DECL_ARGS);
 static  int               pre_TP(DECL_ARGS);  static  int               pre_TP(DECL_ARGS);
Line 47  static void    post_SH(DECL_ARGS);
Line 62  static void    post_SH(DECL_ARGS);
 static  void              post_SS(DECL_ARGS);  static  void              post_SS(DECL_ARGS);
   
 static const struct termact termacts[MAN_MAX] = {  static const struct termact termacts[MAN_MAX] = {
         { NULL, NULL }, /* __ */          { pre_br, NULL }, /* br */
         { NULL, NULL }, /* TH */          { NULL, NULL }, /* TH */
         { pre_SH, post_SH }, /* SH */          { pre_SH, post_SH }, /* SH */
         { pre_SS, post_SS }, /* SS */          { pre_SS, post_SS }, /* SS */
Line 55  static const struct termact termacts[MAN_MAX] = {
Line 70  static const struct termact termacts[MAN_MAX] = {
         { pre_PP, NULL }, /* LP */          { pre_PP, NULL }, /* LP */
         { pre_PP, NULL }, /* PP */          { pre_PP, NULL }, /* PP */
         { pre_PP, NULL }, /* P */          { pre_PP, NULL }, /* P */
         { NULL, NULL }, /* IP */          { pre_IP, NULL }, /* IP */
         { pre_PP, NULL }, /* HP */ /* XXX */          { pre_PP, NULL }, /* HP */ /* FIXME */
         { NULL, NULL }, /* SM */          { NULL, NULL }, /* SM */
         { pre_B, post_B }, /* SB */          { pre_B, post_B }, /* SB */
         { NULL, NULL }, /* BI */          { pre_BI, NULL }, /* BI */
         { NULL, NULL }, /* IB */          { pre_IB, NULL }, /* IB */
         { NULL, NULL }, /* BR */          { pre_BR, NULL }, /* BR */
         { NULL, NULL }, /* RB */          { pre_RB, NULL }, /* RB */
         { NULL, NULL }, /* R */          { NULL, NULL }, /* R */
         { pre_B, post_B }, /* B */          { pre_B, post_B }, /* B */
         { pre_I, post_I }, /* I */          { pre_I, post_I }, /* I */
         { NULL, NULL }, /* IR */          { pre_IR, NULL }, /* IR */
         { NULL, NULL }, /* RI */          { pre_RI, NULL }, /* RI */
           { NULL, NULL }, /* na */
           { pre_I, post_I }, /* i */
           { NULL, NULL }, /* sp */
 };  };
   
 static  void              print_head(struct termp *,  static  void              print_head(struct termp *,
Line 76  static void    print_body(DECL_ARGS);
Line 94  static void    print_body(DECL_ARGS);
 static  void              print_node(DECL_ARGS);  static  void              print_node(DECL_ARGS);
 static  void              print_foot(struct termp *,  static  void              print_foot(struct termp *,
                                 const struct man_meta *);                                  const struct man_meta *);
   static  void              fmt_block_vspace(struct termp *,
                                   const struct man_node *);
   static  int               arg_width(const struct man_node *);
   
   
 int  int
Line 84  man_run(struct termp *p, const struct man *m)
Line 105  man_run(struct termp *p, const struct man *m)
   
         print_head(p, man_meta(m));          print_head(p, man_meta(m));
         p->flags |= TERMP_NOSPACE;          p->flags |= TERMP_NOSPACE;
         print_body(p, man_node(m), man_meta(m));          assert(man_node(m));
           assert(MAN_ROOT == man_node(m)->type);
           if (man_node(m)->child)
                   print_body(p, man_node(m)->child, man_meta(m));
         print_foot(p, man_meta(m));          print_foot(p, man_meta(m));
   
         return(1);          return(1);
 }  }
   
   
   static void
   fmt_block_vspace(struct termp *p, const struct man_node *n)
   {
           term_newln(p);
   
           if (NULL == n->prev)
                   return;
   
           if (MAN_SS == n->prev->tok)
                   return;
           if (MAN_SH == n->prev->tok)
                   return;
   
           term_vspace(p);
   }
   
   
 static int  static int
   arg_width(const struct man_node *n)
   {
           int              i, len;
           const char      *p;
   
           assert(MAN_TEXT == n->type);
           assert(n->string);
   
           p = n->string;
   
           if (0 == (len = (int)strlen(p)))
                   return(-1);
   
           for (i = 0; i < len; i++)
                   if ( ! isdigit((u_char)p[i]))
                           break;
   
           if (i == len - 1)  {
                   if ('n' == p[len - 1] || 'm' == p[len - 1])
                           return(atoi(p));
           } else if (i == len)
                   return(atoi(p));
   
           return(-1);
   }
   
   
   /* ARGSUSED */
   static int
 pre_I(DECL_ARGS)  pre_I(DECL_ARGS)
 {  {
   
Line 100  pre_I(DECL_ARGS)
Line 170  pre_I(DECL_ARGS)
 }  }
   
   
   /* ARGSUSED */
 static void  static void
 post_I(DECL_ARGS)  post_I(DECL_ARGS)
 {  {
Line 108  post_I(DECL_ARGS)
Line 179  post_I(DECL_ARGS)
 }  }
   
   
   /* ARGSUSED */
 static int  static int
   pre_IR(DECL_ARGS)
   {
           const struct man_node *nn;
           int              i;
   
           for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                   if ( ! (i % 2))
                           p->flags |= TERMP_UNDER;
                   if (i > 0)
                           p->flags |= TERMP_NOSPACE;
                   print_node(p, nn, m);
                   if ( ! (i % 2))
                           p->flags &= ~TERMP_UNDER;
           }
           return(0);
   }
   
   
   /* ARGSUSED */
   static int
   pre_IB(DECL_ARGS)
   {
           const struct man_node *nn;
           int              i;
   
           for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                   p->flags |= i % 2 ? TERMP_BOLD : TERMP_UNDER;
                   if (i > 0)
                           p->flags |= TERMP_NOSPACE;
                   print_node(p, nn, m);
                   p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER;
           }
           return(0);
   }
   
   
   /* ARGSUSED */
   static int
   pre_RB(DECL_ARGS)
   {
           const struct man_node *nn;
           int              i;
   
           for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                   if (i % 2)
                           p->flags |= TERMP_BOLD;
                   if (i > 0)
                           p->flags |= TERMP_NOSPACE;
                   print_node(p, nn, m);
                   if (i % 2)
                           p->flags &= ~TERMP_BOLD;
           }
           return(0);
   }
   
   
   /* ARGSUSED */
   static int
   pre_RI(DECL_ARGS)
   {
           const struct man_node *nn;
           int              i;
   
           for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                   if ( ! (i % 2))
                           p->flags |= TERMP_UNDER;
                   if (i > 0)
                           p->flags |= TERMP_NOSPACE;
                   print_node(p, nn, m);
                   if ( ! (i % 2))
                           p->flags &= ~TERMP_UNDER;
           }
           return(0);
   }
   
   
   /* ARGSUSED */
   static int
   pre_BR(DECL_ARGS)
   {
           const struct man_node *nn;
           int              i;
   
           for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                   if ( ! (i % 2))
                           p->flags |= TERMP_BOLD;
                   if (i > 0)
                           p->flags |= TERMP_NOSPACE;
                   print_node(p, nn, m);
                   if ( ! (i % 2))
                           p->flags &= ~TERMP_BOLD;
           }
           return(0);
   }
   
   
   /* ARGSUSED */
   static int
   pre_BI(DECL_ARGS)
   {
           const struct man_node *nn;
           int              i;
   
           for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                   p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD;
                   if (i > 0)
                           p->flags |= TERMP_NOSPACE;
                   print_node(p, nn, m);
                   p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD;
           }
           return(0);
   }
   
   
   /* ARGSUSED */
   static int
 pre_B(DECL_ARGS)  pre_B(DECL_ARGS)
 {  {
   
Line 117  pre_B(DECL_ARGS)
Line 305  pre_B(DECL_ARGS)
 }  }
   
   
   /* ARGSUSED */
 static void  static void
 post_B(DECL_ARGS)  post_B(DECL_ARGS)
 {  {
Line 125  post_B(DECL_ARGS)
Line 314  post_B(DECL_ARGS)
 }  }
   
   
   /* ARGSUSED */
 static int  static int
   pre_br(DECL_ARGS)
   {
   
           term_newln(p);
           return(0);
   }
   
   
   /* ARGSUSED */
   static int
 pre_PP(DECL_ARGS)  pre_PP(DECL_ARGS)
 {  {
   
         term_vspace(p);          term_vspace(p);
           term_vspace(p);
         p->offset = INDENT;          p->offset = INDENT;
           p->flags |= TERMP_NOSPACE;
         return(0);          return(0);
 }  }
   
   
   /* ARGSUSED */
 static int  static int
   pre_IP(DECL_ARGS)
   {
           const struct man_node *nn;
           size_t           offs, sv;
           int              ival;
   
           fmt_block_vspace(p, n);
   
           p->flags |= TERMP_NOSPACE;
   
           sv = p->offset;
           p->offset = INDENT;
   
           if (NULL == n->child)
                   return(1);
   
           p->flags |= TERMP_NOBREAK;
   
           offs = sv;
   
           /*
            * If the last token is number-looking (3m, 3n, 3) then
            * interpret it as the width specifier, else we stick with the
            * prior saved offset.  XXX - obviously not documented.
            */
           for (nn = n->child; nn; nn = nn->next) {
                   if (NULL == nn->next) {
                           ival = arg_width(nn);
                           if (ival >= 0) {
                                   offs = (size_t)ival;
                                   break;
                           }
                   }
                   print_node(p, nn, m);
           }
   
           p->rmargin = p->offset + offs;
   
           term_flushln(p);
   
           p->offset = offs;
           p->rmargin = p->maxrmargin;
   
           p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
   
           return(0);
   }
   
   
   /* ARGSUSED */
   static int
 pre_TP(DECL_ARGS)  pre_TP(DECL_ARGS)
 {  {
         const struct man_node *nn;          const struct man_node *nn;
         size_t           offs;          size_t           offs;
   
         term_vspace(p);          term_vspace(p);
   
         p->offset = INDENT;          p->offset = INDENT;
   
         if (NULL == (nn = n->child))          if (NULL == (nn = n->child))
Line 150  pre_TP(DECL_ARGS)
Line 405  pre_TP(DECL_ARGS)
         if (nn->line == n->line) {          if (nn->line == n->line) {
                 if (MAN_TEXT != nn->type)                  if (MAN_TEXT != nn->type)
                         errx(1, "expected text line argument");                          errx(1, "expected text line argument");
                 offs = atoi(nn->string);                  offs = (size_t)atoi(nn->string);
                 nn = nn->next;                  nn = nn->next;
         } else          } else
                 offs = INDENT;                  offs = INDENT;
Line 165  pre_TP(DECL_ARGS)
Line 420  pre_TP(DECL_ARGS)
 }  }
   
   
   /* ARGSUSED */
 static int  static int
 pre_SS(DECL_ARGS)  pre_SS(DECL_ARGS)
 {  {
Line 175  pre_SS(DECL_ARGS)
Line 431  pre_SS(DECL_ARGS)
 }  }
   
   
   /* ARGSUSED */
 static void  static void
 post_SS(DECL_ARGS)  post_SS(DECL_ARGS)
 {  {
Line 185  post_SS(DECL_ARGS)
Line 442  post_SS(DECL_ARGS)
 }  }
   
   
   /* ARGSUSED */
 static int  static int
 pre_SH(DECL_ARGS)  pre_SH(DECL_ARGS)
 {  {
Line 196  pre_SH(DECL_ARGS)
Line 454  pre_SH(DECL_ARGS)
 }  }
   
   
   /* ARGSUSED */
 static void  static void
 post_SH(DECL_ARGS)  post_SH(DECL_ARGS)
 {  {
Line 210  post_SH(DECL_ARGS)
Line 469  post_SH(DECL_ARGS)
 static void  static void
 print_node(DECL_ARGS)  print_node(DECL_ARGS)
 {  {
         int              c;          int              c, sz;
   
         c = 1;          c = 1;
   
Line 220  print_node(DECL_ARGS)
Line 479  print_node(DECL_ARGS)
                         c = (*termacts[n->tok].pre)(p, n, m);                          c = (*termacts[n->tok].pre)(p, n, m);
                 break;                  break;
         case(MAN_TEXT):          case(MAN_TEXT):
                 if (*n->string) {                  if (0 == *n->string) {
                         term_word(p, n->string);                          term_vspace(p);
                         break;                          break;
                 }                  }
                 term_vspace(p);                  /*
                    * Note!  This is hacky.  Here, we recognise the `\c'
                    * escape embedded in so many -man pages.  It's supposed
                    * to remove the subsequent space, so we mark NOSPACE if
                    * it's encountered in the string.
                    */
                   sz = (int)strlen(n->string);
                   term_word(p, n->string);
                   if (sz >= 2 && n->string[sz - 1] == 'c' &&
                                   n->string[sz - 2] == '\\')
                           p->flags |= TERMP_NOSPACE;
                 break;                  break;
         default:          default:
                 break;                  break;
Line 265  print_foot(struct termp *p, const struct man_meta *met
Line 534  print_foot(struct termp *p, const struct man_meta *met
   
         tm = localtime(&meta->date);          tm = localtime(&meta->date);
   
 #ifdef __OpenBSD__  
         if (NULL == strftime(buf, p->rmargin, "%B %d, %Y", tm))  
 #else  
         if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm))          if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm))
 #endif  
                 err(1, "strftime");                  err(1, "strftime");
   
         /*  
          * This is /slightly/ different from regular groff output  
          * because we don't have page numbers.  Print the following:  
          *  
          * OS                                            MDOCDATE  
          */  
   
         term_vspace(p);          term_vspace(p);
   
         p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;          p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
Line 316  print_head(struct termp *p, const struct man_meta *met
Line 574  print_head(struct termp *p, const struct man_meta *met
         if (NULL == (title = malloc(p->rmargin)))          if (NULL == (title = malloc(p->rmargin)))
                 err(1, "malloc");                  err(1, "malloc");
   
         /*  
          * The header is strange.  It has three components, which are  
          * really two with the first duplicated.  It goes like this:  
          *  
          * IDENTIFIER              TITLE                   IDENTIFIER  
          *  
          * The IDENTIFIER is NAME(SECTION), which is the command-name  
          * (if given, or "unknown" if not) followed by the manual page  
          * section.  These are given in `Dt'.  The TITLE is a free-form  
          * string depending on the manual volume.  If not specified, it  
          * switches on the manual section.  
          */  
   
         if (meta->vol)          if (meta->vol)
                 (void)strlcpy(buf, meta->vol, p->rmargin);                  (void)strlcpy(buf, meta->vol, p->rmargin);
         else          else
Line 338  print_head(struct termp *p, const struct man_meta *met
Line 583  print_head(struct termp *p, const struct man_meta *met
                         meta->title, meta->msec);                          meta->title, meta->msec);
   
         p->offset = 0;          p->offset = 0;
         p->rmargin = (p->maxrmargin - strlen(buf)) / 2;          p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;
         p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;          p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
   
         term_word(p, title);          term_word(p, title);
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.18
CVSweb