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

Diff for /mandoc/term.c between version 1.277 and 1.278

version 1.277, 2018/12/15 19:30:26 version 1.278, 2019/01/03 19:59:55
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) 2010-2018 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2010-2019 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
Line 21 
Line 21 
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
   #include <stdint.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
Line 37  static void   bufferc(struct termp *, char);
Line 38  static void   bufferc(struct termp *, char);
 static  void             encode(struct termp *, const char *, size_t);  static  void             encode(struct termp *, const char *, size_t);
 static  void             encode1(struct termp *, int);  static  void             encode1(struct termp *, int);
 static  void             endline(struct termp *);  static  void             endline(struct termp *);
   static  void             term_field(struct termp *, size_t, size_t,
                                   size_t, size_t);
   static  void             term_fill(struct termp *, size_t *, size_t *,
                                   size_t);
   
   
 void  void
Line 83  term_end(struct termp *p)
Line 88  term_end(struct termp *p)
  * Flush a chunk of text.  By default, break the output line each time   * Flush a chunk of text.  By default, break the output line each time
  * the right margin is reached, and continue output on the next line   * the right margin is reached, and continue output on the next line
  * at the same offset as the chunk itself.  By default, also break the   * at the same offset as the chunk itself.  By default, also break the
  * output line at the end of the chunk.   * output line at the end of the chunk.  There are many flags modifying
  * The following flags may be specified:   * this behaviour, see the comments in the body of the function.
  *  
  *  - TERMP_NOBREAK: Do not break the output line at the right margin,  
  *    but only at the max right margin.  Also, do not break the output  
  *    line at the end of the chunk, such that the next call can pad to  
  *    the next column.  However, if less than p->trailspace blanks,  
  *    which can be 0, 1, or 2, remain to the right margin, the line  
  *    will be broken.  
  *  - TERMP_BRTRSP: Consider trailing whitespace significant  
  *    when deciding whether the chunk fits or not.  
  *  - TERMP_BRIND: If the chunk does not fit and the output line has  
  *    to be broken, start the next line at the right margin instead  
  *    of at the offset.  Used together with TERMP_NOBREAK for the tags  
  *    in various kinds of tagged lists.  
  *  - TERMP_HANG: Do not break the output line at the right margin,  
  *    append the next chunk after it even if this one is too long.  
  *    To be used together with TERMP_NOBREAK.  
  *  - TERMP_NOPAD: Start writing at the current position,  
  *    do not pad with blank characters up to the offset.  
  */   */
 void  void
 term_flushln(struct termp *p)  term_flushln(struct termp *p)
 {  {
         size_t           vis;   /* current visual position on output */          size_t   vbl;      /* Number of blanks to prepend to the output. */
         size_t           vbl;   /* number of blanks to prepend to output */          size_t   vbr;      /* Actual visual position of the end of field. */
         size_t           vend;  /* end of word visual position on output */          size_t   vfield;   /* Desired visual field width. */
         size_t           bp;    /* visual right border position */          size_t   vtarget;  /* Desired visual position of the right margin. */
         size_t           dv;    /* temporary for visual pos calculations */          size_t   ic;       /* Character position in the input buffer. */
         size_t           j;     /* temporary loop index for p->tcol->buf */          size_t   nbr;      /* Number of characters to print in this field. */
         size_t           jhy;   /* last hyph before overflow w/r/t j */  
         size_t           maxvis; /* output position of visible boundary */  
         int              ntab;  /* number of tabs to prepend */  
         int              breakline; /* after this word */  
   
           /*
            * Normally, start writing at the left margin, but with the
            * NOPAD flag, start writing at the current position instead.
            */
   
         vbl = (p->flags & TERMP_NOPAD) || p->tcol->offset < p->viscol ?          vbl = (p->flags & TERMP_NOPAD) || p->tcol->offset < p->viscol ?
             0 : p->tcol->offset - p->viscol;              0 : p->tcol->offset - p->viscol;
         if (p->minbl && vbl < p->minbl)          if (p->minbl && vbl < p->minbl)
                 vbl = p->minbl;                  vbl = p->minbl;
         maxvis = p->tcol->rmargin > p->viscol + vbl ?  
             p->tcol->rmargin - p->viscol - vbl : 0;  
         bp = !(p->flags & TERMP_NOBREAK) ? maxvis :  
             p->maxrmargin > p->viscol + vbl ?  
             p->maxrmargin - p->viscol - vbl : 0;  
         vis = vend = 0;  
   
         if ((p->flags & TERMP_MULTICOL) == 0)          if ((p->flags & TERMP_MULTICOL) == 0)
                 p->tcol->col = 0;                  p->tcol->col = 0;
         while (p->tcol->col < p->tcol->lastcol) {  
   
           /* Loop over output lines. */
   
           for (;;) {
                   vfield = p->tcol->rmargin > p->viscol + vbl ?
                       p->tcol->rmargin - p->viscol - vbl : 0;
   
                 /*                  /*
                  * Handle literal tab characters: collapse all                   * Normally, break the line at the the right margin
                  * subsequent tabs into a single huge set of spaces.                   * of the field, but with the NOBREAK flag, only
                    * break it at the max right margin of the screen,
                    * and with the BRNEVER flag, never break it at all.
                  */                   */
   
                 ntab = 0;                  vtarget = p->flags & TERMP_BRNEVER ? SIZE_MAX :
                 while (p->tcol->col < p->tcol->lastcol &&                      (p->flags & TERMP_NOBREAK) == 0 ? vfield :
                     p->tcol->buf[p->tcol->col] == '\t') {                      p->maxrmargin > p->viscol + vbl ?
                         vend = term_tab_next(vis);                      p->maxrmargin - p->viscol - vbl : 0;
                         vbl += vend - vis;  
                         vis = vend;  
                         ntab++;  
                         p->tcol->col++;  
                 }  
   
                 /*                  /*
                  * Count up visible word characters.  Control sequences                   * Figure out how much text will fit in the field.
                  * (starting with the CSI) aren't counted.  A space                   * If there is whitespace only, print nothing.
                  * generates a non-printing word, which is valid (the                   * Otherwise, print the field content.
                  * space is printed according to regular spacing rules).  
                  */                   */
   
                 jhy = 0;                  term_fill(p, &nbr, &vbr, vtarget);
                 breakline = 0;                  if (nbr == 0)
                 for (j = p->tcol->col; j < p->tcol->lastcol; j++) {                          break;
                         if (p->tcol->buf[j] == '\n') {  
                                 if ((p->flags & TERMP_BRIND) == 0)  
                                         breakline = 1;  
                                 continue;  
                         }  
                         if (p->tcol->buf[j] == ' ' || p->tcol->buf[j] == '\t')  
                                 break;  
   
                         /* Back over the last printed character. */                  term_field(p, vbl, nbr, vbr, vtarget);
                         if (p->tcol->buf[j] == '\b') {  
                                 assert(j);                  /*
                                 vend -= (*p->width)(p, p->tcol->buf[j - 1]);                   * If there is no text left in the field, exit the loop.
                    * If the BRTRSP flag is set, consider trailing
                    * whitespace significant when deciding whether
                    * the field fits or not.
                    */
   
                   for (ic = p->tcol->col; ic < p->tcol->lastcol; ic++) {
                           switch (p->tcol->buf[ic]) {
                           case '\t':
                                   if (p->flags & TERMP_BRTRSP)
                                           vbr = term_tab_next(vbr);
                                 continue;                                  continue;
                           case ' ':
                                   if (p->flags & TERMP_BRTRSP)
                                           vbr += (*p->width)(p, ' ');
                                   continue;
                           case '\n':
                           case ASCII_BREAK:
                                   continue;
                           default:
                                   break;
                         }                          }
                           break;
                   }
                   if (ic == p->tcol->lastcol)
                           break;
   
                         /* Regular word. */                  /*
                         /* Break at the hyphen point if we overrun. */                   * At the location of an automtic line break, input
                         if (vend > vis && vend < bp &&                   * space characters are consumed by the line break.
                             (p->tcol->buf[j] == ASCII_HYPH||                   */
                              p->tcol->buf[j] == ASCII_BREAK))  
                                 jhy = j;  
   
                         /*                  while (p->tcol->col < p->tcol->lastcol &&
                          * Hyphenation now decided, put back a real                      p->tcol->buf[p->tcol->col] == ' ')
                          * hyphen such that we get the correct width.                          p->tcol->col++;
                          */  
                         if (p->tcol->buf[j] == ASCII_HYPH)  
                                 p->tcol->buf[j] = '-';  
   
                         vend += (*p->width)(p, p->tcol->buf[j]);                  /*
                 }                   * In multi-column mode, leave the rest of the text
                    * in the buffer to be handled by a subsequent
                    * invocation, such that the other columns of the
                    * table can be handled first.
                    * In single-column mode, simply break the line.
                    */
   
                   if (p->flags & TERMP_MULTICOL)
                           return;
   
                   endline(p);
                   p->viscol = 0;
   
                 /*                  /*
                  * Find out whether we would exceed the right margin.                   * Normally, start the next line at the same indentation
                  * If so, break to the next line.                   * as this one, but with the BRIND flag, start it at the
                    * right margin instead.  This is used together with
                    * NOBREAK for the tags in various kinds of tagged lists.
                  */                   */
   
                 if (vend > bp && jhy == 0 && vis > 0 &&                  vbl = p->flags & TERMP_BRIND ?
                     (p->flags & TERMP_BRNEVER) == 0) {                      p->tcol->rmargin : p->tcol->offset;
                         if (p->flags & TERMP_MULTICOL)          }
                                 return;  
   
                         endline(p);          /* Reset output state in preparation for the next field. */
                         vend -= vis;  
   
                         /* Use pending tabs on the new line. */          p->col = p->tcol->col = p->tcol->lastcol = 0;
           p->minbl = p->trailspace;
           p->flags &= ~(TERMP_BACKAFTER | TERMP_BACKBEFORE | TERMP_NOPAD);
   
                         vbl = 0;          if (p->flags & TERMP_MULTICOL)
                         while (ntab--)                  return;
                                 vbl = term_tab_next(vbl);  
   
                         /* Re-establish indentation. */          /*
            * The HANG flag means that the next field
            * always follows on the same line.
            * The NOBREAK flag means that the next field
            * follows on the same line unless the field was overrun.
            * Normally, break the line at the end of each field.
            */
   
                         if (p->flags & TERMP_BRIND)          if ((p->flags & TERMP_HANG) == 0 &&
                                 vbl += p->tcol->rmargin;              ((p->flags & TERMP_NOBREAK) == 0 ||
                         else               vbr + term_len(p, p->trailspace) > vfield))
                                 vbl += p->tcol->offset;                  endline(p);
                         maxvis = p->tcol->rmargin > vbl ?  }
                             p->tcol->rmargin - vbl : 0;  
                         bp = !(p->flags & TERMP_NOBREAK) ? maxvis :  
                             p->maxrmargin > vbl ?  p->maxrmargin - vbl : 0;  
                 }  
   
                 /*  /*
                  * Write out the rest of the word.   * Store the number of input characters to print in this field in *nbr
                  */   * and their total visual width to print in *vbr.
    * If there is only whitespace in the field, both remain zero.
    * The desired visual width of the field is provided by vtarget.
    * If the first word is longer, the field will be overrun.
    */
   static void
   term_fill(struct termp *p, size_t *nbr, size_t *vbr, size_t vtarget)
   {
           size_t   ic;        /* Character position in the input buffer. */
           size_t   vis;       /* Visual position of the current character. */
           size_t   vn;        /* Visual position of the next character. */
           int      breakline; /* Break at the end of this word. */
           int      graph;     /* Last character was non-blank. */
   
                 for ( ; p->tcol->col < p->tcol->lastcol; p->tcol->col++) {          *nbr = *vbr = vis = 0;
                         if (vend > bp && jhy > 0 && p->tcol->col > jhy)          breakline = graph = 0;
           for (ic = p->tcol->col; ic < p->tcol->lastcol; ic++) {
                   switch (p->tcol->buf[ic]) {
                   case '\b':  /* Escape \o (overstrike) or backspace markup. */
                           assert(ic > 0);
                           vis -= (*p->width)(p, p->tcol->buf[ic - 1]);
                           continue;
   
                   case '\t':  /* Normal ASCII whitespace. */
                   case ' ':
                   case ASCII_BREAK:  /* Escape \: (breakpoint). */
                           switch (p->tcol->buf[ic]) {
                           case '\t':
                                   vn = term_tab_next(vis);
                                 break;                                  break;
                         if (p->tcol->buf[p->tcol->col] == '\n')                          case ' ':
                                 continue;                                  vn = vis + (*p->width)(p, ' ');
                         if (p->tcol->buf[p->tcol->col] == '\t')  
                                 break;                                  break;
                         if (p->tcol->buf[p->tcol->col] == ' ') {                          case ASCII_BREAK:
                                 j = p->tcol->col;                                  vn = vis;
                                 while (p->tcol->col < p->tcol->lastcol &&  
                                     p->tcol->buf[p->tcol->col] == ' ')  
                                         p->tcol->col++;  
                                 dv = (p->tcol->col - j) * (*p->width)(p, ' ');  
                                 vbl += dv;  
                                 vend += dv;  
                                 break;                                  break;
                         }                          }
                         if (p->tcol->buf[p->tcol->col] == ASCII_NBRSP) {                          /* Can break at the end of a word. */
                                 vbl += (*p->width)(p, ' ');                          if (breakline || vn > vtarget)
                                 continue;                                  break;
                           if (graph) {
                                   *nbr = ic;
                                   *vbr = vis;
                                   graph = 0;
                         }                          }
                         if (p->tcol->buf[p->tcol->col] == ASCII_BREAK)                          vis = vn;
                                 continue;                          continue;
   
                   case '\n':  /* Escape \p (break at the end of the word). */
                           breakline = 1;
                           continue;
   
                   case ASCII_HYPH:  /* Breakable hyphen. */
                           graph = 1;
                         /*                          /*
                          * Now we definitely know there will be                           * We are about to decide whether to break the
                          * printable characters to output,                           * line or not, so we no longer need this hyphen
                          * so write preceding white space now.                           * to be marked as breakable.  Put back a real
                            * hyphen such that we get the correct width.
                          */                           */
                         if (vbl) {                          p->tcol->buf[ic] = '-';
                                 (*p->advance)(p, vbl);                          vis += (*p->width)(p, '-');
                                 p->viscol += vbl;                          if (vis > vtarget) {
                                 vbl = 0;                                  ic++;
                                   break;
                         }                          }
                           *nbr = ic + 1;
                         (*p->letter)(p, p->tcol->buf[p->tcol->col]);                          *vbr = vis;
                         if (p->tcol->buf[p->tcol->col] == '\b')  
                                 p->viscol -= (*p->width)(p,  
                                     p->tcol->buf[p->tcol->col - 1]);  
                         else  
                                 p->viscol += (*p->width)(p,  
                                     p->tcol->buf[p->tcol->col]);  
                 }  
                 vis = vend;  
   
                 if (breakline == 0)  
                         continue;                          continue;
   
                 /* Explicitly requested output line break. */                  case ASCII_NBRSP:  /* Non-breakable space. */
                           p->tcol->buf[ic] = ' ';
                 if (p->flags & TERMP_MULTICOL)                          /* FALLTHROUGH */
                         return;                  default:  /* Printable character. */
                           graph = 1;
                 endline(p);                          vis += (*p->width)(p, p->tcol->buf[ic]);
                 breakline = 0;                          if (vis > vtarget && *nbr > 0)
                 vis = vend = 0;                                  return;
                           continue;
                 /* Re-establish indentation. */                  }
                   break;
                 vbl = p->tcol->offset;  
                 maxvis = p->tcol->rmargin > vbl ?  
                     p->tcol->rmargin - vbl : 0;  
                 bp = !(p->flags & TERMP_NOBREAK) ? maxvis :  
                     p->maxrmargin > vbl ?  p->maxrmargin - vbl : 0;  
         }          }
   
         /*          /*
          * If there was trailing white space, it was not printed;           * If the last word extends to the end of the field without any
          * so reset the cursor position accordingly.           * trailing whitespace, the loop could not check yet whether it
            * can remain on this line.  So do the check now.
          */           */
   
         if (vis > vbl)          if (graph && (vis <= vtarget || *nbr == 0)) {
                 vis -= vbl;                  *nbr = ic;
         else                  *vbr = vis;
                 vis = 0;          }
   }
   
         p->col = p->tcol->col = p->tcol->lastcol = 0;  /*
         p->minbl = p->trailspace;   * Print the contents of one field
         p->flags &= ~(TERMP_BACKAFTER | TERMP_BACKBEFORE | TERMP_NOPAD);   * with an indentation of        vbl      visual columns,
    * an input string length of     nbr      characters,
    * an output width of            vbr      visual columns,
    * and a desired field width of  vtarget  visual columns.
    */
   static void
   term_field(struct termp *p, size_t vbl, size_t nbr, size_t vbr, size_t vtarget)
   {
           size_t   ic;    /* Character position in the input buffer. */
           size_t   vis;   /* Visual position of the current character. */
           size_t   dv;    /* Visual width of the current character. */
           size_t   vn;    /* Visual position of the next character. */
   
         if (p->flags & TERMP_MULTICOL)          vis = 0;
                 return;          for (ic = p->tcol->col; ic < nbr; ic++) {
   
         /* Trailing whitespace is significant in some columns. */                  /*
                    * To avoid the printing of trailing whitespace,
                    * do not print whitespace right away, only count it.
                    */
   
         if (vis && vbl && (TERMP_BRTRSP & p->flags))                  switch (p->tcol->buf[ic]) {
                 vis += vbl;                  case '\n':
                   case ASCII_BREAK:
                           continue;
                   case '\t':
                           vn = term_tab_next(vis);
                           vbl += vn - vis;
                           vis = vn;
                           continue;
                   case ' ':
                   case ASCII_NBRSP:
                           vbl++;
                           vis++;
                           continue;
                   default:
                           break;
                   }
   
         /* If the column was overrun, break the line. */                  /*
         if ((p->flags & TERMP_NOBREAK) == 0 ||                   * We found a non-blank character to print,
             ((p->flags & TERMP_HANG) == 0 &&                   * so write preceding white space now.
              vis + p->trailspace * (*p->width)(p, ' ') > maxvis))                   */
                 endline(p);  
                   if (vbl > 0) {
                           (*p->advance)(p, vbl);
                           p->viscol += vbl;
                           vbl = 0;
                   }
   
                   /* Print the character and adjust the visual position. */
   
                   (*p->letter)(p, p->tcol->buf[ic]);
                   if (p->tcol->buf[ic] == '\b') {
                           dv = (*p->width)(p, p->tcol->buf[ic - 1]);
                           p->viscol -= dv;
                           vis -= dv;
                   } else {
                           dv = (*p->width)(p, p->tcol->buf[ic]);
                           p->viscol += dv;
                           vis += dv;
                   }
           }
           p->tcol->col = nbr;
 }  }
   
 static void  static void

Legend:
Removed from v.1.277  
changed lines
  Added in v.1.278

CVSweb