new bug report from wiz@ regarding Tcl*(3)

[mandoc.git] / term.c

diff --git a/term.c b/term.c
index 4ca15ed6fa589148521299b1c4cbfb3f61314ed6..0d5eafd8a7f9badb483f996085e7338332778dcd 100644 (file)
--- a/term.c
+++ b/term.c
@@ -1,7 +1,7 @@
-/*     $Id: term.c,v 1.201 2011/09/21 09:57:13 schwarze Exp $ */
+/*     $Id: term.c,v 1.216 2014/01/22 20:58:39 schwarze Exp $ */

 /*
  * 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, 2011 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -33,7 +33,8 @@
 #include "term.h"
 #include "main.h"
 
 #include "term.h"
 #include "main.h"
 

-static void             adjbuf(struct termp *p, int);
+static size_t           cond_width(const struct termp *, int, int *);
+static void             adjbuf(struct termp *p, size_t);

 static void             bufferc(struct termp *, char);
 static void             encode(struct termp *, const char *, size_t);
 static void             encode1(struct termp *, int);
 static void             bufferc(struct termp *, char);
 static void             encode(struct termp *, const char *, size_t);
 static void             encode1(struct termp *, int);


@@ -82,9 +83,8 @@ term_end(struct termp *p)
  *  - TERMP_NOBREAK: this is the most important and is used when making
  *    columns.  In short: don't print a newline and instead expect the
  *    next call to do the padding up to the start of the next column.
  *  - TERMP_NOBREAK: this is the most important and is used when making
  *    columns.  In short: don't print a newline and instead expect the
  *    next call to do the padding up to the start of the next column.

- *
- *  - TERMP_TWOSPACE: make sure there is room for at least two space
- *    characters of padding.  Otherwise, rather break the line.
+ *    p->trailspace may be set to 0, 1, or 2, depending on how many
+ *    space characters are required at the end of the column.

  *
  *  - TERMP_DANGLE: don't newline when TERMP_NOBREAK is specified and
  *    the line is overrun, and don't pad-right if it's underrun.
  *
  *  - TERMP_DANGLE: don't newline when TERMP_NOBREAK is specified and
  *    the line is overrun, and don't pad-right if it's underrun.


@@ -104,14 +104,15 @@ term_end(struct termp *p)
 void
 term_flushln(struct termp *p)
 {
 void
 term_flushln(struct termp *p)
 {

-       int              i;     /* current input position in p->buf */
+       size_t           i;     /* current input position in p->buf */
+       int              ntab;  /* number of tabs to prepend */

        size_t           vis;   /* current visual position on output */
        size_t           vbl;   /* number of blanks to prepend to output */
        size_t           vend;  /* end of word visual position on output */
        size_t           bp;    /* visual right border position */
        size_t           dv;    /* temporary for visual pos calculations */
        size_t           vis;   /* current visual position on output */
        size_t           vbl;   /* number of blanks to prepend to output */
        size_t           vend;  /* end of word visual position on output */
        size_t           bp;    /* visual right border position */
        size_t           dv;    /* temporary for visual pos calculations */

-       int              j;     /* temporary loop index for p->buf */
-       int              jhy;   /* last hyph before overflow w/r/t j */
+       size_t           j;     /* temporary loop index for p->buf */
+       size_t           jhy;   /* last hyph before overflow w/r/t j */

        size_t           maxvis; /* output position of visible boundary */
        size_t           mmax; /* used in calculating bp */
 
        size_t           maxvis; /* output position of visible boundary */
        size_t           mmax; /* used in calculating bp */
 


@@ -119,7 +120,12 @@ term_flushln(struct termp *p)
         * First, establish the maximum columns of "visible" content.
         * This is usually the difference between the right-margin and
         * an indentation, but can be, for tagged lists or columns, a
         * First, establish the maximum columns of "visible" content.
         * This is usually the difference between the right-margin and
         * an indentation, but can be, for tagged lists or columns, a

-        * small set of values. 
+        * small set of values.
+        *
+        * The following unsigned-signed subtractions look strange,
+        * but they are actually correct.  If the int p->overstep
+        * is negative, it gets sign extended.  Subtracting that
+        * very large size_t effectively adds a small number to dv.

         */
        assert  (p->rmargin >= p->offset);
        dv     = p->rmargin - p->offset;
         */
        assert  (p->rmargin >= p->offset);
        dv     = p->rmargin - p->offset;


@@ -143,10 +149,12 @@ term_flushln(struct termp *p)
                 * Handle literal tab characters: collapse all
                 * subsequent tabs into a single huge set of spaces.
                 */
                 * Handle literal tab characters: collapse all
                 * subsequent tabs into a single huge set of spaces.
                 */

+               ntab = 0;

                while (i < p->col && '\t' == p->buf[i]) {
                        vend = (vis / p->tabwidth + 1) * p->tabwidth;
                        vbl += vend - vis;
                        vis = vend;
                while (i < p->col && '\t' == p->buf[i]) {
                        vend = (vis / p->tabwidth + 1) * p->tabwidth;
                        vbl += vend - vis;
                        vis = vend;

+                       ntab++;

                        i++;
                }
 
                        i++;
                }
 


@@ -158,7 +166,7 @@ term_flushln(struct termp *p)
                 */
 
                for (j = i, jhy = 0; j < p->col; j++) {
                 */
 
                for (j = i, jhy = 0; j < p->col; j++) {

-                       if ((j && ' ' == p->buf[j]) || '\t' == p->buf[j])
+                       if (' ' == p->buf[j] || '\t' == p->buf[j])

                                break;
 
                        /* Back over the the last printed character. */
                                break;
 
                        /* Back over the the last printed character. */


@@ -171,7 +179,8 @@ term_flushln(struct termp *p)
                        /* Regular word. */
                        /* Break at the hyphen point if we overrun. */
                        if (vend > vis && vend < bp && 
                        /* Regular word. */
                        /* Break at the hyphen point if we overrun. */
                        if (vend > vis && vend < bp && 

-                                       ASCII_HYPH == p->buf[j])
+                           (ASCII_HYPH == p->buf[j] ||
+                            ASCII_BREAK == p->buf[j]))

                                jhy = j;
 
                        vend += (*p->width)(p, p->buf[j]);
                                jhy = j;
 
                        vend += (*p->width)(p, p->buf[j]);


@@ -191,7 +200,16 @@ term_flushln(struct termp *p)
                        } else
                                vbl = p->offset;
 
                        } else
                                vbl = p->offset;
 

-                       /* Remove the p->overstep width. */
+                       /* use pending tabs on the new line */
+
+                       if (0 < ntab)
+                               vbl += ntab * p->tabwidth;
+
+                       /*
+                        * Remove the p->overstep width.
+                        * Again, if p->overstep is negative,
+                        * sign extension does the right thing.
+                        */

 
                        bp += (size_t)p->overstep;
                        p->overstep = 0;
 
                        bp += (size_t)p->overstep;
                        p->overstep = 0;


@@ -207,7 +225,7 @@ term_flushln(struct termp *p)
                                j = i;
                                while (' ' == p->buf[i])
                                        i++;
                                j = i;
                                while (' ' == p->buf[i])
                                        i++;

-                               dv = (size_t)(i - j) * (*p->width)(p, ' ');
+                               dv = (i - j) * (*p->width)(p, ' ');

                                vbl += dv;
                                vend += dv;
                                break;
                                vbl += dv;
                                vend += dv;
                                break;


@@ -216,6 +234,8 @@ term_flushln(struct termp *p)
                                vbl += (*p->width)(p, ' ');
                                continue;
                        }
                                vbl += (*p->width)(p, ' ');
                                continue;
                        }

+                       if (ASCII_BREAK == p->buf[i])
+                               continue;

 
                        /*
                         * Now we definitely know there will be
 
                        /*
                         * Now we definitely know there will be


@@ -260,20 +280,17 @@ term_flushln(struct termp *p)
        }
 
        if (TERMP_HANG & p->flags) {
        }
 
        if (TERMP_HANG & p->flags) {

-               /* We need one blank after the tag. */
-               p->overstep = (int)(vis - maxvis + (*p->width)(p, ' '));
+               p->overstep = (int)(vis - maxvis +
+                               p->trailspace * (*p->width)(p, ' '));

 
                /*
 
                /*

-                * Behave exactly the same way as groff:

                 * If we have overstepped the margin, temporarily move
                 * it to the right and flag the rest of the line to be
                 * shorter.
                 * If we have overstepped the margin, temporarily move
                 * it to the right and flag the rest of the line to be
                 * shorter.

-                * If we landed right at the margin, be happy.
-                * If we are one step before the margin, temporarily
-                * move it one step LEFT and flag the rest of the line
-                * to be longer.
+                * If there is a request to keep the columns together,
+                * allow negative overstep when the column is not full.

                 */
                 */

-               if (p->overstep < -1)
+               if (p->trailspace && p->overstep < 0)

                        p->overstep = 0;
                return;
 
                        p->overstep = 0;
                return;
 


@@ -281,8 +298,7 @@ term_flushln(struct termp *p)
                return;
 
        /* If the column was overrun, break the line. */
                return;
 
        /* If the column was overrun, break the line. */

-       if (maxvis <= vis +
-           ((TERMP_TWOSPACE & p->flags) ? (*p->width)(p, ' ') : 0)) {
+       if (maxvis < vis + p->trailspace * (*p->width)(p, ' ')) {

                (*p->endline)(p);
                p->viscol = 0;
        }
                (*p->endline)(p);
                p->viscol = 0;
        }


@@ -316,7 +332,10 @@ term_vspace(struct termp *p)
 
        term_newln(p);
        p->viscol = 0;
 
        term_newln(p);
        p->viscol = 0;

-       (*p->endline)(p);
+       if (0 < p->skipvsp)
+               p->skipvsp--;
+       else
+               (*p->endline)(p);

 }
 
 void
 }
 
 void


@@ -369,7 +388,7 @@ void
 term_fontpopq(struct termp *p, const void *key)
 {
 
 term_fontpopq(struct termp *p, const void *key)
 {
 

-       while (p->fonti >= 0 && key != &p->fontq[p->fonti])
+       while (p->fonti >= 0 && key < (void *)(p->fontq + p->fonti))

                p->fonti--;
        assert(p->fonti >= 0);
 }
                p->fonti--;
        assert(p->fonti >= 0);
 }


@@ -391,6 +410,7 @@ term_fontpop(struct termp *p)
 void
 term_word(struct termp *p, const char *word)
 {
 void
 term_word(struct termp *p, const char *word)
 {

+       const char       nbrsp[2] = { ASCII_NBRSP, 0 };

        const char      *seq, *cp;
        char             c;
        int              sz, uc;
        const char      *seq, *cp;
        char             c;
        int              sz, uc;


@@ -399,29 +419,42 @@ term_word(struct termp *p, const char *word)
 
        if ( ! (TERMP_NOSPACE & p->flags)) {
                if ( ! (TERMP_KEEP & p->flags)) {
 
        if ( ! (TERMP_NOSPACE & p->flags)) {
                if ( ! (TERMP_KEEP & p->flags)) {

-                       if (TERMP_PREKEEP & p->flags)
-                               p->flags |= TERMP_KEEP;

                        bufferc(p, ' ');
                        if (TERMP_SENTENCE & p->flags)
                                bufferc(p, ' ');
                } else
                        bufferc(p, ASCII_NBRSP);
        }
                        bufferc(p, ' ');
                        if (TERMP_SENTENCE & p->flags)
                                bufferc(p, ' ');
                } else
                        bufferc(p, ASCII_NBRSP);
        }

+       if (TERMP_PREKEEP & p->flags)
+               p->flags |= TERMP_KEEP;

 
        if ( ! (p->flags & TERMP_NONOSPACE))
                p->flags &= ~TERMP_NOSPACE;
        else
                p->flags |= TERMP_NOSPACE;
 
 
        if ( ! (p->flags & TERMP_NONOSPACE))
                p->flags &= ~TERMP_NOSPACE;
        else
                p->flags |= TERMP_NOSPACE;
 

-       p->flags &= ~(TERMP_SENTENCE | TERMP_IGNDELIM);
+       p->flags &= ~TERMP_SENTENCE;

 
        while ('\0' != *word) {
 
        while ('\0' != *word) {

-               if ((ssz = strcspn(word, "\\")) > 0)
+               if ('\\' != *word) {
+                       if (TERMP_SKIPCHAR & p->flags) {
+                               p->flags &= ~TERMP_SKIPCHAR;
+                               word++;
+                               continue;
+                       }
+                       if (TERMP_NBRWORD & p->flags) {
+                               if (' ' == *word) {
+                                       encode(p, nbrsp, 1);
+                                       word++;
+                                       continue;
+                               }
+                               ssz = strcspn(word, "\\ ");
+                       } else
+                               ssz = strcspn(word, "\\");

                        encode(p, word, ssz);
                        encode(p, word, ssz);

-
-               word += (int)ssz;
-               if ('\\' != *word)
+                       word += (int)ssz;

                        continue;
                        continue;

+               }

 
                word++;
                esc = mandoc_escape(&word, &seq, &sz);
 
                word++;
                esc = mandoc_escape(&word, &seq, &sz);


@@ -468,6 +501,9 @@ term_word(struct termp *p, const char *word)
                case (ESCAPE_FONTITALIC):
                        term_fontrepl(p, TERMFONT_UNDER);
                        break;
                case (ESCAPE_FONTITALIC):
                        term_fontrepl(p, TERMFONT_UNDER);
                        break;

+               case (ESCAPE_FONTBI):
+                       term_fontrepl(p, TERMFONT_BI);
+                       break;

                case (ESCAPE_FONT):
                        /* FALLTHROUGH */
                case (ESCAPE_FONTROMAN):
                case (ESCAPE_FONT):
                        /* FALLTHROUGH */
                case (ESCAPE_FONTROMAN):


@@ -477,17 +513,23 @@ term_word(struct termp *p, const char *word)
                        term_fontlast(p);
                        break;
                case (ESCAPE_NOSPACE):
                        term_fontlast(p);
                        break;
                case (ESCAPE_NOSPACE):

-                       if ('\0' == *word)
+                       if (TERMP_SKIPCHAR & p->flags)
+                               p->flags &= ~TERMP_SKIPCHAR;
+                       else if ('\0' == *word)

                                p->flags |= TERMP_NOSPACE;
                        break;
                                p->flags |= TERMP_NOSPACE;
                        break;

+               case (ESCAPE_SKIPCHAR):
+                       p->flags |= TERMP_SKIPCHAR;
+                       break;

                default:
                        break;
                }
        }
                default:
                        break;
                }
        }

+       p->flags &= ~TERMP_NBRWORD;

 }
 
 static void
 }
 
 static void

-adjbuf(struct termp *p, int sz)
+adjbuf(struct termp *p, size_t sz)

 {
 
        if (0 == p->maxcols)
 {
 
        if (0 == p->maxcols)


@@ -495,8 +537,7 @@ adjbuf(struct termp *p, int sz)
        while (sz >= p->maxcols)
                p->maxcols <<= 2;
 
        while (sz >= p->maxcols)
                p->maxcols <<= 2;
 

-       p->buf = mandoc_realloc
-               (p->buf, sizeof(int) * (size_t)p->maxcols);
+       p->buf = mandoc_realloc(p->buf, sizeof(int) * p->maxcols);

 }
 
 static void
 }
 
 static void


@@ -519,31 +560,39 @@ encode1(struct termp *p, int c)
 {
        enum termfont     f;
 
 {
        enum termfont     f;
 

-       if (p->col + 4 >= p->maxcols)
-               adjbuf(p, p->col + 4);
+       if (TERMP_SKIPCHAR & p->flags) {
+               p->flags &= ~TERMP_SKIPCHAR;
+               return;
+       }
+
+       if (p->col + 6 >= p->maxcols)
+               adjbuf(p, p->col + 6);

 
        f = term_fonttop(p);
 
 
        f = term_fonttop(p);
 

-       if (TERMFONT_NONE == f) {
-               p->buf[p->col++] = c;
-               return;
-       } else if (TERMFONT_UNDER == f) {
+       if (TERMFONT_UNDER == f || TERMFONT_BI == f) {

                p->buf[p->col++] = '_';
                p->buf[p->col++] = '_';

-       } else
-               p->buf[p->col++] = c;
-
-       p->buf[p->col++] = 8;
+               p->buf[p->col++] = 8;
+       }
+       if (TERMFONT_BOLD == f || TERMFONT_BI == f) {
+               if (ASCII_HYPH == c)
+                       p->buf[p->col++] = '-';
+               else
+                       p->buf[p->col++] = c;
+               p->buf[p->col++] = 8;
+       }

        p->buf[p->col++] = c;
 }
 
 static void
 encode(struct termp *p, const char *word, size_t sz)
 {
        p->buf[p->col++] = c;
 }
 
 static void
 encode(struct termp *p, const char *word, size_t sz)
 {

-       enum termfont     f;
-       int               i, len;
+       size_t            i;

 
 

-       /* LINTED */
-       len = sz;
+       if (TERMP_SKIPCHAR & p->flags) {
+               p->flags &= ~TERMP_SKIPCHAR;
+               return;
+       }

 
        /*
         * Encode and buffer a string of characters.  If the current
 
        /*
         * Encode and buffer a string of characters.  If the current


@@ -551,35 +600,25 @@ encode(struct termp *p, const char *word, size_t sz)
         * character by character.
         */
 
         * character by character.
         */
 

-       if (TERMFONT_NONE == (f = term_fonttop(p))) {
-               if (p->col + len >= p->maxcols) 
-                       adjbuf(p, p->col + len);
-               for (i = 0; i < len; i++)
+       if (TERMFONT_NONE == term_fonttop(p)) {
+               if (p->col + sz >= p->maxcols) 
+                       adjbuf(p, p->col + sz);
+               for (i = 0; i < sz; i++)

                        p->buf[p->col++] = word[i];
                return;
        }
 
        /* Pre-buffer, assuming worst-case. */
 
                        p->buf[p->col++] = word[i];
                return;
        }
 
        /* Pre-buffer, assuming worst-case. */
 

-       if (p->col + 1 + (len * 3) >= p->maxcols)
-               adjbuf(p, p->col + 1 + (len * 3));
-
-       for (i = 0; i < len; i++) {
-               if (ASCII_HYPH != word[i] &&
-                   ! isgraph((unsigned char)word[i])) {
-                       p->buf[p->col++] = word[i];
-                       continue;
-               }
+       if (p->col + 1 + (sz * 5) >= p->maxcols)
+               adjbuf(p, p->col + 1 + (sz * 5));

 
 

-               if (TERMFONT_UNDER == f)
-                       p->buf[p->col++] = '_';
-               else if (ASCII_HYPH == word[i])
-                       p->buf[p->col++] = '-';
+       for (i = 0; i < sz; i++) {
+               if (ASCII_HYPH == word[i] ||
+                   isgraph((unsigned char)word[i]))
+                       encode1(p, word[i]);

                else
                        p->buf[p->col++] = word[i];
                else
                        p->buf[p->col++] = word[i];

-
-               p->buf[p->col++] = 8;
-               p->buf[p->col++] = word[i];

        }
 }
 
        }
 }
 


@@ -590,15 +629,26 @@ term_len(const struct termp *p, size_t sz)
        return((*p->width)(p, ' ') * sz);
 }
 
        return((*p->width)(p, ' ') * sz);
 }
 

+static size_t
+cond_width(const struct termp *p, int c, int *skip)
+{
+
+       if (*skip) {
+               (*skip) = 0;
+               return(0);
+       } else
+               return((*p->width)(p, c));
+}

 
 size_t
 term_strlen(const struct termp *p, const char *cp)
 {
        size_t           sz, rsz, i;
 
 size_t
 term_strlen(const struct termp *p, const char *cp)
 {
        size_t           sz, rsz, i;

-       int              ssz, c;
+       int              ssz, skip, c;

        const char      *seq, *rhs;
        enum mandoc_esc  esc;
        const char      *seq, *rhs;
        enum mandoc_esc  esc;

-       static const char rej[] = { '\\', ASCII_HYPH, ASCII_NBRSP, '\0' };
+       static const char rej[] = { '\\', ASCII_NBRSP, ASCII_HYPH,
+                       ASCII_BREAK, '\0' };

 
        /*
         * Account for escaped sequences within string length
 
        /*
         * Account for escaped sequences within string length


@@ -607,12 +657,12 @@ term_strlen(const struct termp *p, const char *cp)
         */
 
        sz = 0;
         */
 
        sz = 0;

+       skip = 0;

        while ('\0' != *cp) {
                rsz = strcspn(cp, rej);
                for (i = 0; i < rsz; i++)
        while ('\0' != *cp) {
                rsz = strcspn(cp, rej);
                for (i = 0; i < rsz; i++)

-                       sz += (*p->width)(p, *cp++);
+                       sz += cond_width(p, *cp++, &skip);

 
 

-               c = 0;

                switch (*cp) {
                case ('\\'):
                        cp++;
                switch (*cp) {
                case ('\\'):
                        cp++;


@@ -627,14 +677,14 @@ term_strlen(const struct termp *p, const char *cp)
                                                (seq + 1, ssz - 1);
                                        if ('\0' == c)
                                                break;
                                                (seq + 1, ssz - 1);
                                        if ('\0' == c)
                                                break;

-                                       sz += (*p->width)(p, c);
+                                       sz += cond_width(p, c, &skip);

                                        continue;
                                case (ESCAPE_SPECIAL):
                                        c = mchars_spec2cp
                                                (p->symtab, seq, ssz);
                                        if (c <= 0)
                                                break;
                                        continue;
                                case (ESCAPE_SPECIAL):
                                        c = mchars_spec2cp
                                                (p->symtab, seq, ssz);
                                        if (c <= 0)
                                                break;

-                                       sz += (*p->width)(p, c);
+                                       sz += cond_width(p, c, &skip);

                                        continue;
                                default:
                                        break;
                                        continue;
                                default:
                                        break;


@@ -644,12 +694,12 @@ term_strlen(const struct termp *p, const char *cp)
 
                        switch (esc) {
                        case (ESCAPE_UNICODE):
 
                        switch (esc) {
                        case (ESCAPE_UNICODE):

-                               sz += (*p->width)(p, '?');
+                               sz += cond_width(p, '?', &skip);

                                break;
                        case (ESCAPE_NUMBERED):
                                c = mchars_num2char(seq, ssz);
                                if ('\0' != c)
                                break;
                        case (ESCAPE_NUMBERED):
                                c = mchars_num2char(seq, ssz);
                                if ('\0' != c)

-                                       sz += (*p->width)(p, c);
+                                       sz += cond_width(p, c, &skip);

                                break;
                        case (ESCAPE_SPECIAL):
                                rhs = mchars_spec2str
                                break;
                        case (ESCAPE_SPECIAL):
                                rhs = mchars_spec2str


@@ -661,6 +711,9 @@ term_strlen(const struct termp *p, const char *cp)
                                rhs = seq;
                                rsz = ssz;
                                break;
                                rhs = seq;
                                rsz = ssz;
                                break;

+                       case (ESCAPE_SKIPCHAR):
+                               skip = 1;
+                               break;

                        default:
                                break;
                        }
                        default:
                                break;
                        }


@@ -668,16 +721,23 @@ term_strlen(const struct termp *p, const char *cp)
                        if (NULL == rhs)
                                break;
 
                        if (NULL == rhs)
                                break;
 

+                       if (skip) {
+                               skip = 0;
+                               break;
+                       }
+

                        for (i = 0; i < rsz; i++)
                                sz += (*p->width)(p, *rhs++);
                        break;
                case (ASCII_NBRSP):
                        for (i = 0; i < rsz; i++)
                                sz += (*p->width)(p, *rhs++);
                        break;
                case (ASCII_NBRSP):

-                       sz += (*p->width)(p, ' ');
+                       sz += cond_width(p, ' ', &skip);

                        cp++;
                        break;
                case (ASCII_HYPH):
                        cp++;
                        break;
                case (ASCII_HYPH):

-                       sz += (*p->width)(p, '-');
+                       sz += cond_width(p, '-', &skip);

                        cp++;
                        cp++;

+                       /* FALLTHROUGH */
+               case (ASCII_BREAK):

                        break;
                default:
                        break;
                        break;
                default:
                        break;