]> git.cameronkatri.com Git - mandoc.git/blobdiff - term.c
In -Tutf8 mode, make sure that hyphens get counted against the output line
[mandoc.git] / term.c
diff --git a/term.c b/term.c
index 04d55d6730583bb940c467172906cdb979397be4..d3b217745149e2f9741ddfe43a17c530440569a2 100644 (file)
--- a/term.c
+++ b/term.c
@@ -1,7 +1,7 @@
-/*     $Id: term.c,v 1.194 2011/05/17 22:32:45 kristaps Exp $ */
+/*     $Id: term.c,v 1.217 2014/03/13 19:23:50 schwarze Exp $ */
 /*
- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * 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
@@ -33,7 +33,8 @@
 #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);
@@ -79,22 +80,17 @@ term_end(struct termp *p)
  *
  * The following flags may be specified:
  *
- *  - TERMP_NOLPAD: when beginning to write the line, don't left-pad the
- *    offset value.  This is useful when doing columnar lists where the
- *    prior column has right-padded.
- *
  *  - TERMP_NOBREAK: this is the most important and is used when making
- *    columns.  In short: don't print a newline and instead pad to the
- *    right margin.  Used in conjunction with TERMP_NOLPAD.
- *
- *  - TERMP_TWOSPACE: when padding, make sure there are at least two
- *    space characters of padding.  Otherwise, rather break the line.
+ *    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.
+ *    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_HANG: like TERMP_DANGLE, but doesn't newline when
- *    overruning, instead save the position and continue at that point
+ *    overrunning, instead save the position and continue at that point
  *    when the next invocation.
  *
  *  In-line line breaking:
@@ -108,14 +104,15 @@ term_end(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 */
-       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 */
 
@@ -123,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
-        * 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;
@@ -134,9 +136,10 @@ term_flushln(struct termp *p)
        bp = TERMP_NOBREAK & p->flags ? mmax : maxvis;
 
        /*
-        * Indent the first line of a paragraph.
+        * Calculate the required amount of padding.
         */
-       vbl = p->flags & TERMP_NOLPAD ? (size_t)0 : p->offset;
+       vbl = p->offset + p->overstep > p->viscol ?
+             p->offset + p->overstep - p->viscol : 0;
 
        vis = vend = 0;
        i = 0;
@@ -146,10 +149,12 @@ term_flushln(struct termp *p)
                 * 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;
+                       ntab++;
                        i++;
                }
 
@@ -161,7 +166,7 @@ term_flushln(struct termp *p)
                 */
 
                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. */
@@ -174,9 +179,17 @@ term_flushln(struct termp *p)
                        /* 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;
 
+                       /*
+                        * Hyphenation now decided, put back a real
+                        * hyphen such that we get the correct width.
+                        */
+                       if (ASCII_HYPH == p->buf[j])
+                               p->buf[j] = '-';
+
                        vend += (*p->width)(p, p->buf[j]);
                }
 
@@ -187,16 +200,23 @@ term_flushln(struct termp *p)
                if (vend > bp && 0 == jhy && vis > 0) {
                        vend -= vis;
                        (*p->endline)(p);
+                       p->viscol = 0;
                        if (TERMP_NOBREAK & p->flags) {
-                               p->viscol = p->rmargin;
-                               (*p->advance)(p, p->rmargin);
+                               vbl = p->rmargin;
                                vend += p->rmargin - p->offset;
-                       } else {
-                               p->viscol = 0;
+                       } 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;
@@ -212,7 +232,7 @@ term_flushln(struct termp *p)
                                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;
@@ -221,6 +241,8 @@ term_flushln(struct termp *p)
                                vbl += (*p->width)(p, ' ');
                                continue;
                        }
+                       if (ASCII_BREAK == p->buf[i])
+                               continue;
 
                        /*
                         * Now we definitely know there will be
@@ -233,13 +255,11 @@ term_flushln(struct termp *p)
                                vbl = 0;
                        }
 
-                       if (ASCII_HYPH == p->buf[i]) {
-                               (*p->letter)(p, '-');
-                               p->viscol += (*p->width)(p, '-');
-                       } else {
-                               (*p->letter)(p, p->buf[i]);
+                       (*p->letter)(p, p->buf[i]);
+                       if (8 == p->buf[i])
+                               p->viscol -= (*p->width)(p, p->buf[i-1]);
+                       else 
                                p->viscol += (*p->width)(p, p->buf[i]);
-                       }
                }
                vis = vend;
        }
@@ -248,7 +268,8 @@ term_flushln(struct termp *p)
         * If there was trailing white space, it was not printed;
         * so reset the cursor position accordingly.
         */
-       vis -= vbl;
+       if (vis)
+               vis -= vbl;
 
        p->col = 0;
        p->overstep = 0;
@@ -260,38 +281,27 @@ term_flushln(struct termp *p)
        }
 
        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 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) {
-                       assert((int)maxvis + p->overstep >= 0);
-                       maxvis += (size_t)p->overstep;
-               } else
+               if (p->trailspace && p->overstep < 0)
                        p->overstep = 0;
+               return;
 
        } else if (TERMP_DANGLE & p->flags)
                return;
 
-       /* Right-pad. */
-       if (maxvis > vis +
-           ((TERMP_TWOSPACE & p->flags) ? (*p->width)(p, ' ') : 0)) {
-               p->viscol += maxvis - vis;
-               (*p->advance)(p, maxvis - vis);
-               vis += (maxvis - vis);
-       } else {        /* ...or newline break. */
+       /* If the column was overrun, break the line. */
+       if (maxvis < vis + p->trailspace * (*p->width)(p, ' ')) {
                (*p->endline)(p);
-               p->viscol = p->rmargin;
-               (*p->advance)(p, p->rmargin);
+               p->viscol = 0;
        }
 }
 
@@ -306,12 +316,8 @@ term_newln(struct termp *p)
 {
 
        p->flags |= TERMP_NOSPACE;
-       if (0 == p->col && 0 == p->viscol) {
-               p->flags &= ~TERMP_NOLPAD;
-               return;
-       }
-       term_flushln(p);
-       p->flags &= ~TERMP_NOLPAD;
+       if (p->col || p->viscol)
+               term_flushln(p);
 }
 
 
@@ -327,7 +333,10 @@ term_vspace(struct termp *p)
 
        term_newln(p);
        p->viscol = 0;
-       (*p->endline)(p);
+       if (0 < p->skipvsp)
+               p->skipvsp--;
+       else
+               (*p->endline)(p);
 }
 
 void
@@ -380,7 +389,7 @@ void
 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);
 }
@@ -402,6 +411,7 @@ term_fontpop(struct termp *p)
 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;
@@ -410,54 +420,75 @@ term_word(struct termp *p, const char *word)
 
        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);
        }
+       if (TERMP_PREKEEP & p->flags)
+               p->flags |= TERMP_KEEP;
 
        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) {
-               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);
-
-               word += (int)ssz;
-               if ('\\' != *word)
+                       word += (int)ssz;
                        continue;
+               }
 
                word++;
                esc = mandoc_escape(&word, &seq, &sz);
                if (ESCAPE_ERROR == esc)
                        break;
 
-               switch (esc) {
-               case (ESCAPE_UNICODE):
-                       if (TERMENC_ASCII == p->enc) {
-                               encode1(p, '?');
+               if (TERMENC_ASCII != p->enc)
+                       switch (esc) {
+                       case (ESCAPE_UNICODE):
+                               uc = mchars_num2uc(seq + 1, sz - 1);
+                               if ('\0' == uc)
+                                       break;
+                               encode1(p, uc);
+                               continue;
+                       case (ESCAPE_SPECIAL):
+                               uc = mchars_spec2cp(p->symtab, seq, sz);
+                               if (uc <= 0)
+                                       break;
+                               encode1(p, uc);
+                               continue;
+                       default:
                                break;
                        }
-                       uc = mchars_num2uc(seq + 1, sz - 1);
-                       if ('\0' != uc)
-                               encode1(p, uc);
+
+               switch (esc) {
+               case (ESCAPE_UNICODE):
+                       encode1(p, '?');
                        break;
                case (ESCAPE_NUMBERED):
-                       if ('\0' != (c = mchars_num2char(seq, sz)))
+                       c = mchars_num2char(seq, sz);
+                       if ('\0' != c)
                                encode(p, &c, 1);
                        break;
-               case (ESCAPE_PREDEF):
-                       cp = mchars_res2str(p->symtab, seq, sz, &ssz);
-                       if (NULL != cp)
-                               encode(p, cp, ssz);
-                       break;
                case (ESCAPE_SPECIAL):
                        cp = mchars_spec2str(p->symtab, seq, sz, &ssz);
                        if (NULL != cp) 
@@ -471,6 +502,11 @@ term_word(struct termp *p, const char *word)
                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):
                        term_fontrepl(p, TERMFONT_NONE);
                        break;
@@ -478,17 +514,23 @@ term_word(struct termp *p, const char *word)
                        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;
+               case (ESCAPE_SKIPCHAR):
+                       p->flags |= TERMP_SKIPCHAR;
+                       break;
                default:
                        break;
                }
        }
+       p->flags &= ~TERMP_NBRWORD;
 }
 
 static void
-adjbuf(struct termp *p, int sz)
+adjbuf(struct termp *p, size_t sz)
 {
 
        if (0 == p->maxcols)
@@ -496,8 +538,7 @@ adjbuf(struct termp *p, int sz)
        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
@@ -520,31 +561,39 @@ encode1(struct termp *p, int c)
 {
        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);
 
-       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++] = '_';
-       } 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)
 {
-       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
@@ -552,32 +601,25 @@ encode(struct termp *p, const char *word, size_t sz)
         * 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. */
 
-       if (p->col + 1 + (len * 3) >= p->maxcols)
-               adjbuf(p, p->col + 1 + (len * 3));
+       if (p->col + 1 + (sz * 5) >= p->maxcols)
+               adjbuf(p, p->col + 1 + (sz * 5));
 
-       for (i = 0; i < len; i++) {
-               if ( ! isgraph((unsigned char)word[i])) {
-                       p->buf[p->col++] = word[i];
-                       continue;
-               }
-
-               if (TERMFONT_UNDER == f)
-                       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];
-
-               p->buf[p->col++] = 8;
-               p->buf[p->col++] = word[i];
        }
 }
 
@@ -588,14 +630,26 @@ term_len(const struct termp *p, size_t 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;
-       int              ssz, c;
+       int              ssz, skip, c;
        const char      *seq, *rhs;
-       static const char rej[] = { '\\', ASCII_HYPH, ASCII_NBRSP, '\0' };
+       enum mandoc_esc  esc;
+       static const char rej[] = { '\\', ASCII_NBRSP, ASCII_HYPH,
+                       ASCII_BREAK, '\0' };
 
        /*
         * Account for escaped sequences within string length
@@ -604,36 +658,49 @@ term_strlen(const struct termp *p, const char *cp)
         */
 
        sz = 0;
+       skip = 0;
        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++;
-                       rhs = NULL;
-                       switch (mandoc_escape(&cp, &seq, &ssz)) {
-                       case (ESCAPE_ERROR):
+                       esc = mandoc_escape(&cp, &seq, &ssz);
+                       if (ESCAPE_ERROR == esc)
                                return(sz);
-                       case (ESCAPE_UNICODE):
-                               if (TERMENC_ASCII != p->enc) {
-                                       sz += (*p->width)(p, '?');
+
+                       if (TERMENC_ASCII != p->enc)
+                               switch (esc) {
+                               case (ESCAPE_UNICODE):
+                                       c = mchars_num2uc
+                                               (seq + 1, ssz - 1);
+                                       if ('\0' == c)
+                                               break;
+                                       sz += cond_width(p, c, &skip);
+                                       continue;
+                               case (ESCAPE_SPECIAL):
+                                       c = mchars_spec2cp
+                                               (p->symtab, seq, ssz);
+                                       if (c <= 0)
+                                               break;
+                                       sz += cond_width(p, c, &skip);
+                                       continue;
+                               default:
                                        break;
                                }
-                               c = mchars_num2uc(seq + 1, ssz - 1);
-                               if ('\0' != c)
-                                       sz += (*p->width)(p, c);
+
+                       rhs = NULL;
+
+                       switch (esc) {
+                       case (ESCAPE_UNICODE):
+                               sz += cond_width(p, '?', &skip);
                                break;
                        case (ESCAPE_NUMBERED):
                                c = mchars_num2char(seq, ssz);
                                if ('\0' != c)
-                                       sz += (*p->width)(p, c);
-                               break;
-                       case (ESCAPE_PREDEF):
-                               rhs = mchars_res2str
-                                       (p->symtab, seq, ssz, &rsz);
+                                       sz += cond_width(p, c, &skip);
                                break;
                        case (ESCAPE_SPECIAL):
                                rhs = mchars_spec2str
@@ -645,6 +712,9 @@ term_strlen(const struct termp *p, const char *cp)
                                rhs = seq;
                                rsz = ssz;
                                break;
+                       case (ESCAPE_SKIPCHAR):
+                               skip = 1;
+                               break;
                        default:
                                break;
                        }
@@ -652,16 +722,23 @@ term_strlen(const struct termp *p, const char *cp)
                        if (NULL == rhs)
                                break;
 
+                       if (skip) {
+                               skip = 0;
+                               break;
+                       }
+
                        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):
-                       sz += (*p->width)(p, '-');
+                       sz += cond_width(p, '-', &skip);
                        cp++;
+                       /* FALLTHROUGH */
+               case (ASCII_BREAK):
                        break;
                default:
                        break;