]> git.cameronkatri.com Git - mandoc.git/blobdiff - term.c
Clean up some tight spots in mandoc's default mode: pessimistically
[mandoc.git] / term.c
diff --git a/term.c b/term.c
index b4beb633bcdd1fef151b07cf3f03834884b80a22..603a6a34253131999ab906ecd46fbb1a6ba5e501 100644 (file)
--- a/term.c
+++ b/term.c
@@ -1,6 +1,7 @@
-/*     $Id: term.c,v 1.139 2010/05/24 21:51:20 schwarze Exp $ */
+/*     $Id: term.c,v 1.165 2010/07/26 21:58:41 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 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
 
 #include <assert.h>
 #include <ctype.h>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
-#include <time.h>
 
 #include "mandoc.h"
 #include "chars.h"
 #include "out.h"
 #include "term.h"
-#include "man.h"
-#include "mdoc.h"
 #include "main.h"
 
-static struct termp     *term_alloc(enum termenc, size_t);
-static void              term_free(struct termp *);
-static void              spec(struct termp *, const char *, size_t);
+static void              spec(struct termp *, enum roffdeco,
+                               const char *, size_t);
 static void              res(struct termp *, const char *, size_t);
-static void              buffera(struct termp *, const char *, size_t);
 static void              bufferc(struct termp *, char);
 static void              adjbuf(struct termp *p, size_t);
 static void              encode(struct termp *, const char *, size_t);
 
 
-void *
-ascii_alloc(size_t width)
+void
+term_free(struct termp *p)
 {
 
-       return(term_alloc(TERMENC_ASCII, width));
+       if (p->buf)
+               free(p->buf);
+       if (p->symtab)
+               chars_free(p->symtab);
+
+       free(p);
 }
 
 
 void
-terminal_free(void *arg)
+term_begin(struct termp *p, term_margin head, 
+               term_margin foot, const void *arg)
 {
 
-       term_free((struct termp *)arg);
+       p->headf = head;
+       p->footf = foot;
+       p->argf = arg;
+       (*p->begin)(p);
 }
 
 
-static void
-term_free(struct termp *p)
+void
+term_end(struct termp *p)
 {
 
-       if (p->buf)
-               free(p->buf);
-       if (p->symtab)
-               chars_free(p->symtab);
-
-       free(p);
+       (*p->end)(p);
 }
 
 
-static struct termp *
-term_alloc(enum termenc enc, size_t width)
+struct termp *
+term_alloc(enum termenc enc)
 {
-       struct termp *p;
+       struct termp    *p;
 
        p = calloc(1, sizeof(struct termp));
        if (NULL == p) {
                perror(NULL);
                exit(EXIT_FAILURE);
        }
-       p->tabwidth = 5;
+
        p->enc = enc;
-       /* Enforce some lower boundary. */
-       if (width < 60)
-               width = 60;
-       p->defrmargin = width - 2;
        return(p);
 }
 
@@ -137,8 +134,10 @@ term_flushln(struct termp *p)
        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 */
-       int              j;     /* temporary loop index */
-       size_t           maxvis, mmax;
+       int              j;     /* temporary loop index for p->buf */
+       int              jhy;   /* last hyph before overflow w/r/t j */
+       size_t           maxvis; /* output position of visible boundary */
+       size_t           mmax; /* used in calculating bp */
 
        /*
         * First, establish the maximum columns of "visible" content.
@@ -163,21 +162,17 @@ term_flushln(struct termp *p)
         */
        vbl = p->flags & TERMP_NOLPAD ? 0 : p->offset;
 
-       /* 
-        * FIXME: if bp is zero, we still output the first word before
-        * breaking the line.
-        */
-
        vis = vend = i = 0;
-       while (i < (int)p->col) {
 
+       while (i < (int)p->col) {
                /*
-                * Handle literal tab characters.
+                * Handle literal tab characters: collapse all
+                * subsequent tabs into a single huge set of spaces.
                 */
                for (j = i; j < (int)p->col; j++) {
                        if ('\t' != p->buf[j])
                                break;
-                       vend = (vis/p->tabwidth+1)*p->tabwidth;
+                       vend = (vis / p->tabwidth + 1) * p->tabwidth;
                        vbl += vend - vis;
                        vis = vend;
                }
@@ -190,26 +185,36 @@ term_flushln(struct termp *p)
                 */
 
                /* LINTED */
-               for ( ; j < (int)p->col; j++) {
+               for (jhy = 0; j < (int)p->col; j++) {
                        if ((j && ' ' == p->buf[j]) || '\t' == p->buf[j])
                                break;
-                       if (8 == p->buf[j])
-                               vend--;
-                       else
-                               vend++;
+
+                       /* Back over the the last printed character. */
+                       if (8 == p->buf[j]) {
+                               assert(j);
+                               vend -= (*p->width)(p, p->buf[j - 1]);
+                               continue;
+                       }
+
+                       /* Regular word. */
+                       /* Break at the hyphen point if we overrun. */
+                       if (vend > vis && vend < bp && 
+                                       ASCII_HYPH == p->buf[j])
+                               jhy = j;
+
+                       vend += (*p->width)(p, p->buf[j]);
                }
 
                /*
                 * Find out whether we would exceed the right margin.
                 * If so, break to the next line.
                 */
-               if (vend > bp && vis > 0) {
+               if (vend > bp && 0 == jhy && vis > 0) {
                        vend -= vis;
-                       putchar('\n');
+                       (*p->endline)(p);
                        if (TERMP_NOBREAK & p->flags) {
                                p->viscol = p->rmargin;
-                               for (j = 0; j < (int)p->rmargin; j++)
-                                       putchar(' ');
+                               (*p->advance)(p, p->rmargin);
                                vend += p->rmargin - p->offset;
                        } else {
                                p->viscol = 0;
@@ -231,17 +236,19 @@ term_flushln(struct termp *p)
 
                /* Write out the [remaining] word. */
                for ( ; i < (int)p->col; i++) {
+                       if (vend > bp && jhy > 0 && i > jhy)
+                               break;
                        if ('\t' == p->buf[i])
                                break;
                        if (' ' == p->buf[i]) {
-                               while (' ' == p->buf[i]) {
-                                       vbl++;
+                               j = i;
+                               while (' ' == p->buf[i])
                                        i++;
-                               }
+                               vbl += (i - j) * (*p->width)(p, ' ');
                                break;
                        }
                        if (ASCII_NBRSP == p->buf[i]) {
-                               vbl++;
+                               vbl += (*p->width)(p, ' ');
                                continue;
                        }
 
@@ -251,13 +258,18 @@ term_flushln(struct termp *p)
                         * so write preceding white space now.
                         */
                        if (vbl) {
-                               for (j = 0; j < (int)vbl; j++)
-                                       putchar(' ');
+                               (*p->advance)(p, vbl);
                                p->viscol += vbl;
                                vbl = 0;
                        }
-                       putchar(p->buf[i]);
-                       p->viscol += 1;
+
+                       if (ASCII_HYPH == p->buf[i]) {
+                               (*p->letter)(p, '-');
+                               p->viscol += (*p->width)(p, '-');
+                       } else {
+                               (*p->letter)(p, p->buf[i]);
+                               p->viscol += (*p->width)(p, p->buf[i]);
+                       }
                }
                vend += vbl;
                vis = vend;
@@ -268,14 +280,14 @@ term_flushln(struct termp *p)
 
        if ( ! (TERMP_NOBREAK & p->flags)) {
                p->viscol = 0;
-               putchar('\n');
+               (*p->endline)(p);
                return;
        }
 
        if (TERMP_HANG & p->flags) {
                /* We need one blank after the tag. */
                p->overstep = /* LINTED */
-                       vis - maxvis + 1;
+                       vis - maxvis + (*p->width)(p, ' ');
 
                /*
                 * Behave exactly the same way as groff:
@@ -299,15 +311,15 @@ term_flushln(struct termp *p)
 
        /* Right-pad. */
        if (maxvis > vis + /* LINTED */
-                       ((TERMP_TWOSPACE & p->flags) ? 1 : 0)) {
+                       ((TERMP_TWOSPACE & p->flags) ? 
+                        (*p->width)(p, ' ') : 0)) {
                p->viscol += maxvis - vis;
-               for ( ; vis < maxvis; vis++)
-                       putchar(' ');
+               (*p->advance)(p, maxvis - vis);
+               vis += (maxvis - vis);
        } else {        /* ...or newline break. */
-               putchar('\n');
+               (*p->endline)(p);
                p->viscol = p->rmargin;
-               for (i = 0; i < (int)p->rmargin; i++)
-                       putchar(' ');
+               (*p->advance)(p, p->rmargin);
        }
 }
 
@@ -343,19 +355,21 @@ term_vspace(struct termp *p)
 
        term_newln(p);
        p->viscol = 0;
-       putchar('\n');
+       (*p->endline)(p);
 }
 
 
 static void
-spec(struct termp *p, const char *word, size_t len)
+spec(struct termp *p, enum roffdeco d, const char *word, size_t len)
 {
        const char      *rhs;
        size_t           sz;
 
-       rhs = chars_a2ascii(p->symtab, word, len, &sz);
+       rhs = chars_spec2str(p->symtab, word, len, &sz);
        if (rhs) 
                encode(p, rhs, sz);
+       else if (DECO_SSPECIAL == d)
+               encode(p, word, len);
 }
 
 
@@ -365,7 +379,7 @@ res(struct termp *p, const char *word, size_t len)
        const char      *rhs;
        size_t           sz;
 
-       rhs = chars_a2res(p->symtab, word, len, &sz);
+       rhs = chars_res2str(p->symtab, word, len, &sz);
        if (rhs)
                encode(p, rhs, sz);
 }
@@ -476,9 +490,14 @@ term_word(struct termp *p, const char *word)
                }
 
        if ( ! (TERMP_NOSPACE & p->flags)) {
-               bufferc(p, ' ');
-               if (TERMP_SENTENCE & 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 ( ! (p->flags & TERMP_NONOSPACE))
@@ -486,14 +505,13 @@ term_word(struct termp *p, const char *word)
 
        p->flags &= ~TERMP_SENTENCE;
 
-       /* FIXME: use strcspn. */
-
        while (*word) {
-               if ('\\' != *word) {
-                       encode(p, word, 1);
-                       word++;
+               if ((ssz = strcspn(word, "\\")) > 0)
+                       encode(p, word, ssz);
+
+               word += ssz;
+               if ('\\' != *word)
                        continue;
-               }
 
                seq = ++word;
                sz = a2roffdeco(&deco, &seq, &ssz);
@@ -503,7 +521,9 @@ term_word(struct termp *p, const char *word)
                        res(p, seq, ssz);
                        break;
                case (DECO_SPECIAL):
-                       spec(p, seq, ssz);
+                       /* FALLTHROUGH */
+               case (DECO_SSPECIAL):
+                       spec(p, deco, seq, ssz);
                        break;
                case (DECO_BOLD):
                        term_fontrepl(p, TERMFONT_BOLD);
@@ -530,7 +550,7 @@ term_word(struct termp *p, const char *word)
         * Note that we don't process the pipe: the parser sees it as
         * punctuation, but we don't in terms of typography.
         */
-       if (sv[0] && 0 == sv[1])
+       if (sv[0] && '\0' == sv[1])
                switch (sv[0]) {
                case('('):
                        /* FALLTHROUGH */
@@ -560,18 +580,6 @@ adjbuf(struct termp *p, size_t sz)
 }
 
 
-static void
-buffera(struct termp *p, const char *word, size_t sz)
-{
-
-       if (p->col + sz >= p->maxcols) 
-               adjbuf(p, p->col + sz);
-
-       memcpy(&p->buf[(int)p->col], word, sz);
-       p->col += sz;
-}
-
-
 static void
 bufferc(struct termp *p, char c)
 {
@@ -596,29 +604,58 @@ encode(struct termp *p, const char *word, size_t sz)
         */
 
        if (TERMFONT_NONE == (f = term_fonttop(p))) {
-               buffera(p, word, sz);
+               if (p->col + sz >= p->maxcols) 
+                       adjbuf(p, p->col + sz);
+               memcpy(&p->buf[(int)p->col], word, sz);
+               p->col += sz;
                return;
        }
 
+       /* Pre-buffer, assuming worst-case. */
+
+       if (p->col + 1 + (sz * 3) >= p->maxcols)
+               adjbuf(p, p->col + 1 + (sz * 3));
+
        for (i = 0; i < (int)sz; i++) {
                if ( ! isgraph((u_char)word[i])) {
-                       bufferc(p, word[i]);
+                       p->buf[(int)p->col++] = word[i];
                        continue;
                }
 
                if (TERMFONT_UNDER == f)
-                       bufferc(p, '_');
+                       p->buf[(int)p->col++] = '_';
                else
-                       bufferc(p, word[i]);
+                       p->buf[(int)p->col++] = word[i];
 
-               bufferc(p, 8);
-               bufferc(p, word[i]);
+               p->buf[(int)p->col++] = 8;
+               p->buf[(int)p->col++] = word[i];
        }
 }
 
 
 size_t
-term_vspan(const struct roffsu *su)
+term_len(const struct termp *p, size_t sz)
+{
+
+       return((*p->width)(p, ' ') * sz);
+}
+
+
+size_t
+term_strlen(const struct termp *p, const char *cp)
+{
+       size_t           sz;
+
+       for (sz = 0; *cp; cp++)
+               sz += (*p->width)(p, *cp);
+
+       return(sz);
+}
+
+
+/* ARGSUSED */
+size_t
+term_vspan(const struct termp *p, const struct roffsu *su)
 {
        double           r;
 
@@ -654,41 +691,13 @@ term_vspan(const struct roffsu *su)
 
 
 size_t
-term_hspan(const struct roffsu *su)
+term_hspan(const struct termp *p, const struct roffsu *su)
 {
-       double           r;
-
-       /* XXX: CM, IN, and PT are approximations. */
-
-       switch (su->unit) {
-       case (SCALE_CM):
-               r = 4 * su->scale;
-               break;
-       case (SCALE_IN):
-               /* XXX: this is an approximation. */
-               r = 10 * su->scale;
-               break;
-       case (SCALE_PC):
-               r = (10 * su->scale) / 6;
-               break;
-       case (SCALE_PT):
-               r = (10 * su->scale) / 72;
-               break;
-       case (SCALE_MM):
-               r = su->scale / 1000; /* FIXME: double-check. */
-               break;
-       case (SCALE_VS):
-               r = su->scale * 2 - 1; /* FIXME: double-check. */
-               break;
-       default:
-               r = su->scale;
-               break;
-       }
+       double           v;
 
-       if (r < 0.0)
-               r = 0.0;
-       return((size_t)/* LINTED */
-                       r);
+       v = ((*p->hspan)(p, su));
+       if (v < 0.0)
+               v = 0.0;
+       return((size_t) /* LINTED */
+                       v);
 }
-
-