Add manual page for mandoc-db (mostly to document the file format of

[mandoc.git] / term.c

diff --git a/term.c b/term.c
index 02aedef6e7bea8c1dbd4574d0ae13f823ee95af5..32b04e9f26c06d9891a0404ed2268eeb1adece9f 100644 (file)
--- a/term.c
+++ b/term.c
@@ -1,6 +1,7 @@
-/*     $Id: term.c,v 1.158 2010/07/03 16:02:12 schwarze Exp $ */
+/*     $Id: term.c,v 1.182 2011/03/22 14:05:45 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2011 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


@@ -28,15 +29,13 @@
 #include <string.h>
 
 #include "mandoc.h"
 #include <string.h>
 
 #include "mandoc.h"

-#include "chars.h"

 #include "out.h"
 #include "out.h"

-#include "regs.h"

 #include "term.h"
 #include "main.h"
 
 #include "term.h"
 #include "main.h"
 

-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              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);
 static void              bufferc(struct termp *, char);
 static void              adjbuf(struct termp *p, size_t);
 static void              encode(struct termp *, const char *, size_t);


@@ -80,12 +79,7 @@ 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 = mandoc_calloc(1, sizeof(struct termp));

        p->enc = enc;
        return(p);
 }
        p->enc = enc;
        return(p);
 }


@@ -134,6 +128,7 @@ 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 */
        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           maxvis; /* output position of visible boundary */
        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 */


@@ -145,36 +140,32 @@ term_flushln(struct termp *p)
         * an indentation, but can be, for tagged lists or columns, a
         * small set of values. 
         */
         * an indentation, but can be, for tagged lists or columns, a
         * small set of values. 
         */

-
-       assert(p->offset < p->rmargin);
-
-       maxvis = (int)(p->rmargin - p->offset) - p->overstep < 0 ?
-               /* LINTED */ 
-               0 : p->rmargin - p->offset - p->overstep;
-       mmax = (int)(p->maxrmargin - p->offset) - p->overstep < 0 ?
-               /* LINTED */
-               0 : p->maxrmargin - p->offset - p->overstep;
+       assert  (p->rmargin >= p->offset);
+       dv     = p->rmargin - p->offset;
+       maxvis = (int)dv > p->overstep ? dv - (size_t)p->overstep : 0;
+       dv     = p->maxrmargin - p->offset;
+       mmax   = (int)dv > p->overstep ? dv - (size_t)p->overstep : 0;

 
        bp = TERMP_NOBREAK & p->flags ? mmax : maxvis;
 
        /*
         * Indent the first line of a paragraph.
         */
 
        bp = TERMP_NOBREAK & p->flags ? mmax : maxvis;
 
        /*
         * Indent the first line of a paragraph.
         */

-       vbl = p->flags & TERMP_NOLPAD ? 0 : p->offset;
+       vbl = p->flags & TERMP_NOLPAD ? (size_t)0 : p->offset;

 
 

-       vis = vend = i = 0;
+       vis = vend = 0;
+       i = 0;

 
        while (i < (int)p->col) {
                /*
                 * Handle literal tab characters: collapse all
                 * subsequent tabs into a single huge set of spaces.
                 */
 
        while (i < (int)p->col) {
                /*
                 * 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;
+               while (i < (int)p->col && '\t' == p->buf[i]) {

                        vend = (vis / p->tabwidth + 1) * p->tabwidth;
                        vbl += vend - vis;
                        vis = vend;
                        vend = (vis / p->tabwidth + 1) * p->tabwidth;
                        vbl += vend - vis;
                        vis = vend;

+                       i++;

                }
 
                /*
                }
 
                /*


@@ -184,8 +175,7 @@ term_flushln(struct termp *p)
                 * space is printed according to regular spacing rules).
                 */
 
                 * space is printed according to regular spacing rules).
                 */
 

-               /* LINTED */
-               for (jhy = 0; j < (int)p->col; j++) {
+               for (j = i, jhy = 0; j < (int)p->col; j++) {

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


@@ -223,17 +213,10 @@ term_flushln(struct termp *p)
 
                        /* Remove the p->overstep width. */
 
 
                        /* Remove the p->overstep width. */
 

-                       bp += (int)/* LINTED */
-                               p->overstep;
+                       bp += (size_t)p->overstep;

                        p->overstep = 0;
                }
 
                        p->overstep = 0;
                }
 

-               /*
-                * Skip leading tabs, they were handled above.
-                */
-               while (i < (int)p->col && '\t' == p->buf[i])
-                       i++;
-

                /* Write out the [remaining] word. */
                for ( ; i < (int)p->col; i++) {
                        if (vend > bp && jhy > 0 && i > jhy)
                /* Write out the [remaining] word. */
                for ( ; i < (int)p->col; i++) {
                        if (vend > bp && jhy > 0 && i > jhy)


@@ -241,10 +224,12 @@ term_flushln(struct termp *p)
                        if ('\t' == p->buf[i])
                                break;
                        if (' ' == p->buf[i]) {
                        if ('\t' == p->buf[i])
                                break;
                        if (' ' == p->buf[i]) {

-                               while (' ' == p->buf[i]) {
-                                       vbl += (*p->width)(p, p->buf[i]);
+                               j = i;
+                               while (' ' == p->buf[i])

                                        i++;
                                        i++;

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

                                break;
                        }
                        if (ASCII_NBRSP == p->buf[i]) {
                                break;
                        }
                        if (ASCII_NBRSP == p->buf[i]) {


@@ -271,10 +256,15 @@ term_flushln(struct termp *p)
                                p->viscol += (*p->width)(p, p->buf[i]);
                        }
                }
                                p->viscol += (*p->width)(p, p->buf[i]);
                        }
                }

-               vend += vbl;

                vis = vend;
        }
 
                vis = vend;
        }
 

+       /*
+        * If there was trailing white space, it was not printed;
+        * so reset the cursor position accordingly.
+        */
+       vis -= vbl;
+

        p->col = 0;
        p->overstep = 0;
 
        p->col = 0;
        p->overstep = 0;
 


@@ -286,8 +276,7 @@ term_flushln(struct termp *p)
 
        if (TERMP_HANG & p->flags) {
                /* We need one blank after the tag. */
 
        if (TERMP_HANG & p->flags) {
                /* We need one blank after the tag. */

-               p->overstep = /* LINTED */
-                       vis - maxvis + (*p->width)(p, ' ');
+               p->overstep = (int)(vis - maxvis + (*p->width)(p, ' '));

 
                /*
                 * Behave exactly the same way as groff:
 
                /*
                 * Behave exactly the same way as groff:


@@ -301,8 +290,7 @@ term_flushln(struct termp *p)
                 */
                if (p->overstep >= -1) {
                        assert((int)maxvis + p->overstep >= 0);
                 */
                if (p->overstep >= -1) {
                        assert((int)maxvis + p->overstep >= 0);

-                       /* LINTED */
-                       maxvis += p->overstep;
+                       maxvis += (size_t)p->overstep;

                } else
                        p->overstep = 0;
 
                } else
                        p->overstep = 0;
 


@@ -310,9 +298,8 @@ term_flushln(struct termp *p)
                return;
 
        /* Right-pad. */
                return;
 
        /* Right-pad. */

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

                p->viscol += maxvis - vis;
                (*p->advance)(p, maxvis - vis);
                vis += (maxvis - vis);
                p->viscol += maxvis - vis;
                (*p->advance)(p, maxvis - vis);
                vis += (maxvis - vis);


@@ -360,14 +347,27 @@ term_vspace(struct termp *p)
 
 
 static void
 
 
 static void

-spec(struct termp *p, const char *word, size_t len)
+numbered(struct termp *p, const char *word, size_t len)
+{
+       const char      *rhs;
+
+       rhs = chars_num2char(word, len);
+       if (rhs) 
+               encode(p, rhs, 1);
+}
+
+
+static void
+spec(struct termp *p, enum roffdeco d, const char *word, size_t len)

 {
        const char      *rhs;
        size_t           sz;
 
 {
        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);
        if (rhs) 
                encode(p, rhs, sz);

+       else if (DECO_SSPECIAL == d)
+               encode(p, word, len);

 }
 
 
 }
 
 


@@ -377,12 +377,7 @@ res(struct termp *p, const char *word, size_t len)
        const char      *rhs;
        size_t           sz;
 
        const char      *rhs;
        size_t           sz;
 

-       rhs = chars_a2res(p->symtab, word, len, &sz);
-       if (NULL == rhs) {
-               rhs = roff_getstrn(word, len);
-               if (rhs)
-                       sz = strlen(rhs);
-       }
+       rhs = chars_res2str(p->symtab, word, len, &sz);

        if (rhs)
                encode(p, rhs, sz);
 }
        if (rhs)
                encode(p, rhs, sz);
 }


@@ -462,36 +457,11 @@ void
 term_word(struct termp *p, const char *word)
 {
        const char      *sv, *seq;
 term_word(struct termp *p, const char *word)
 {
        const char      *sv, *seq;

-       int              sz;

        size_t           ssz;
        enum roffdeco    deco;
 
        sv = word;
 
        size_t           ssz;
        enum roffdeco    deco;
 
        sv = word;
 

-       if (word[0] && '\0' == word[1])
-               switch (word[0]) {
-               case('.'):
-                       /* FALLTHROUGH */
-               case(','):
-                       /* FALLTHROUGH */
-               case(';'):
-                       /* FALLTHROUGH */
-               case(':'):
-                       /* FALLTHROUGH */
-               case('?'):
-                       /* FALLTHROUGH */
-               case('!'):
-                       /* FALLTHROUGH */
-               case(')'):
-                       /* FALLTHROUGH */
-               case(']'):
-                       if ( ! (TERMP_IGNDELIM & p->flags))
-                               p->flags |= TERMP_NOSPACE;
-                       break;
-               default:
-                       break;
-               }
-

        if ( ! (TERMP_NOSPACE & p->flags)) {
                if ( ! (TERMP_KEEP & p->flags)) {
                        if (TERMP_PREKEEP & p->flags)
        if ( ! (TERMP_NOSPACE & p->flags)) {
                if ( ! (TERMP_KEEP & p->flags)) {
                        if (TERMP_PREKEEP & p->flags)


@@ -505,27 +475,33 @@ term_word(struct termp *p, const char *word)
 
        if ( ! (p->flags & TERMP_NONOSPACE))
                p->flags &= ~TERMP_NOSPACE;
 
        if ( ! (p->flags & TERMP_NONOSPACE))
                p->flags &= ~TERMP_NOSPACE;

+       else
+               p->flags |= TERMP_NOSPACE;

 
 

-       p->flags &= ~TERMP_SENTENCE;
-
-       /* FIXME: use strcspn. */
+       p->flags &= ~(TERMP_SENTENCE | TERMP_IGNDELIM);

 
        while (*word) {
 
        while (*word) {

-               if ('\\' != *word) {
-                       encode(p, word, 1);
-                       word++;
+               if ((ssz = strcspn(word, "\\")) > 0)
+                       encode(p, word, ssz);
+
+               word += (int)ssz;
+               if ('\\' != *word)

                        continue;
                        continue;

-               }

 
                seq = ++word;
 
                seq = ++word;

-               sz = a2roffdeco(&deco, &seq, &ssz);
+               word += a2roffdeco(&deco, &seq, &ssz);

 
                switch (deco) {
 
                switch (deco) {

+               case (DECO_NUMBERED):
+                       numbered(p, seq, ssz);
+                       break;

                case (DECO_RESERVED):
                        res(p, seq, ssz);
                        break;
                case (DECO_SPECIAL):
                case (DECO_RESERVED):
                        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);
                        break;
                case (DECO_BOLD):
                        term_fontrepl(p, TERMFONT_BOLD);


@@ -543,25 +519,9 @@ term_word(struct termp *p, const char *word)
                        break;
                }
 
                        break;
                }
 

-               word += sz;

                if (DECO_NOSPACE == deco && '\0' == *word)
                        p->flags |= TERMP_NOSPACE;
        }
                if (DECO_NOSPACE == deco && '\0' == *word)
                        p->flags |= TERMP_NOSPACE;
        }

-
-       /* 
-        * 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])
-               switch (sv[0]) {
-               case('('):
-                       /* FALLTHROUGH */
-               case('['):
-                       p->flags |= TERMP_NOSPACE;
-                       break;
-               default:
-                       break;
-               }

 }
 
 
 }
 
 


@@ -574,23 +534,7 @@ adjbuf(struct termp *p, size_t sz)
        while (sz >= p->maxcols)
                p->maxcols <<= 2;
 
        while (sz >= p->maxcols)
                p->maxcols <<= 2;
 

-       p->buf = realloc(p->buf, p->maxcols);
-       if (NULL == p->buf) {
-               perror(NULL);
-               exit(EXIT_FAILURE);
-       }
-}
-
-
-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;
+       p->buf = mandoc_realloc(p->buf, p->maxcols);

 }
 
 
 }
 
 


@@ -618,23 +562,31 @@ encode(struct termp *p, const char *word, size_t sz)
         */
 
        if (TERMFONT_NONE == (f = term_fonttop(p))) {
         */
 
        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;
        }
 
                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])) {
        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)
                        continue;
                }
 
                if (TERMFONT_UNDER == f)

-                       bufferc(p, '_');
+                       p->buf[(int)p->col++] = '_';

                else
                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];

        }
 }
 
        }
 }
 


@@ -650,10 +602,54 @@ term_len(const struct termp *p, size_t sz)
 size_t
 term_strlen(const struct termp *p, const char *cp)
 {
 size_t
 term_strlen(const struct termp *p, const char *cp)
 {

-       size_t           sz;
+       size_t           sz, ssz, rsz, i;
+       enum roffdeco    d;
+       const char      *seq, *rhs;

 
 

-       for (sz = 0; *cp; cp++)
-               sz += (*p->width)(p, *cp);
+       for (sz = 0; '\0' != *cp; )
+               /*
+                * Account for escaped sequences within string length
+                * calculations.  This follows the logic in term_word()
+                * as we must calculate the width of produced strings.
+                */
+               if ('\\' == *cp) {
+                       seq = ++cp;
+                       cp += a2roffdeco(&d, &seq, &ssz);
+
+                       switch (d) {
+                       case (DECO_RESERVED):
+                               rhs = chars_res2str
+                                       (p->symtab, seq, ssz, &rsz);
+                               break;
+                       case (DECO_SPECIAL):
+                               /* FALLTHROUGH */
+                       case (DECO_SSPECIAL):
+                               rhs = chars_spec2str
+                                       (p->symtab, seq, ssz, &rsz);
+
+                               /* Allow for one-char escapes. */
+                               if (DECO_SSPECIAL != d || rhs)
+                                       break;
+
+                               rhs = seq;
+                               rsz = ssz;
+                               break;
+                       default:
+                               rhs = NULL;
+                               break;
+                       }
+
+                       if (rhs)
+                               for (i = 0; i < rsz; i++)
+                                       sz += (*p->width)(p, *rhs++);
+               } else if (ASCII_NBRSP == *cp) {
+                       sz += (*p->width)(p, ' ');
+                       cp++;
+               } else if (ASCII_HYPH == *cp) {
+                       sz += (*p->width)(p, '-');
+                       cp++;
+               } else
+                       sz += (*p->width)(p, *cp++);

 
        return(sz);
 }
 
        return(sz);
 }