Have mandoc-db accumulate manual page descriptions (`Nd' in -mdoc parlance)

[mandoc.git] / term.c

diff --git a/term.c b/term.c
index c9ce322ee8a909684abe3910b62d552feeeec1a5..12722b97373d82dc5f4c1508d26039a0dfc0a1e3 100644 (file)
--- a/term.c
+++ b/term.c
@@ -1,7 +1,7 @@
-/*     $Id: term.c,v 1.159 2010/07/04 22:04:04 schwarze Exp $ */
+/*     $Id: term.c,v 1.184 2011/04/09 15:29:40 kristaps Exp $ */

 /*
  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>

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


@@ -29,15 +29,12 @@
 #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"
 
 static void              spec(struct termp *, const char *, size_t);
 static void              res(struct termp *, const char *, size_t);
 #include "term.h"
 #include "main.h"
 
 static void              spec(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);


@@ -81,12 +78,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);
 }


@@ -135,6 +127,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 */


@@ -146,36 +139,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++;

                }
 
                /*
                }
 
                /*


@@ -185,8 +174,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;
 


@@ -224,17 +212,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)


@@ -242,10 +223,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]) {


@@ -272,10 +255,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;
 


@@ -287,8 +275,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:


@@ -302,8 +289,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;
 


@@ -311,9 +297,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,15 +345,28 @@ term_vspace(struct termp *p)
 }
 
 
 }
 
 

+static void
+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, const char *word, size_t len)
 {
        const char      *rhs;
        size_t           sz;
 
 static void
 spec(struct termp *p, 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);
        if (rhs) 
                encode(p, rhs, sz);

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

 }
 
 
 }
 
 


@@ -378,12 +376,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 +455,10 @@ 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      *sv, *seq;
+       const char      *seq;

        int              sz;
        size_t           ssz;
        int              sz;
        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;
-               }
+       enum mandoc_esc  esc;

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


@@ -506,63 +473,54 @@ 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;
+       p->flags &= ~(TERMP_SENTENCE | TERMP_IGNDELIM);

 
 

-       /* FIXME: use strcspn. */
+       while ('\0' != *word) {
+               if ((ssz = strcspn(word, "\\")) > 0)
+                       encode(p, word, ssz);

 
 

-       while (*word) {
-               if ('\\' != *word) {
-                       encode(p, word, 1);
-                       word++;
+               word += (int)ssz;
+               if ('\\' != *word)

                        continue;
                        continue;

-               }

 
 

-               seq = ++word;
-               sz = a2roffdeco(&deco, &seq, &ssz);
+               word++;
+               esc = mandoc_escape(&word, &seq, &sz);
+               if (ESCAPE_ERROR == esc)
+                       break;

 
 

-               switch (deco) {
-               case (DECO_RESERVED):
-                       res(p, seq, ssz);
+               switch (esc) {
+               case (ESCAPE_NUMBERED):
+                       numbered(p, seq, sz);
+                       break;
+               case (ESCAPE_PREDEF):
+                       res(p, seq, sz);

                        break;
                        break;

-               case (DECO_SPECIAL):
-                       spec(p, seq, ssz);
+               case (ESCAPE_SPECIAL):
+                       spec(p, seq, sz);

                        break;
                        break;

-               case (DECO_BOLD):
+               case (ESCAPE_FONTBOLD):

                        term_fontrepl(p, TERMFONT_BOLD);
                        break;
                        term_fontrepl(p, TERMFONT_BOLD);
                        break;

-               case (DECO_ITALIC):
+               case (ESCAPE_FONTITALIC):

                        term_fontrepl(p, TERMFONT_UNDER);
                        break;
                        term_fontrepl(p, TERMFONT_UNDER);
                        break;

-               case (DECO_ROMAN):
+               case (ESCAPE_FONTROMAN):

                        term_fontrepl(p, TERMFONT_NONE);
                        break;
                        term_fontrepl(p, TERMFONT_NONE);
                        break;

-               case (DECO_PREVIOUS):
+               case (ESCAPE_FONTPREV):

                        term_fontlast(p);
                        break;
                        term_fontlast(p);
                        break;

-               default:
-                       break;
-               }
-
-               word += sz;
-               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;
+               case (ESCAPE_NOSPACE):
+                       if ('\0' == *word)
+                               p->flags |= TERMP_NOSPACE;

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

+       }

 }
 
 
 }
 
 


@@ -575,23 +533,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);

 }
 
 
 }
 
 


@@ -619,23 +561,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];

        }
 }
 
        }
 }
 


@@ -651,10 +601,64 @@ 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, rsz, i;
+       int              ssz;
+       enum mandoc_esc  esc;
+       const char      *seq, *rhs;
+
+       /*
+        * Account for escaped sequences within string length
+        * calculations.  This follows the logic in term_word() as we
+        * must calculate the width of produced strings.
+        */
+
+       sz = 0;
+       while ('\0' != *cp)
+               switch (*cp) {
+               case ('\\'):
+                       ++cp;
+                       esc = mandoc_escape(&cp, &seq, &ssz);
+                       if (ESCAPE_ERROR == esc)
+                               return(sz);
+
+                       switch (esc) {
+                       case (ESCAPE_PREDEF):
+                               rhs = chars_res2str
+                                       (p->symtab, seq, ssz, &rsz);
+                               break;
+                       case (ESCAPE_SPECIAL):
+                               rhs = chars_spec2str
+                                       (p->symtab, seq, ssz, &rsz);
+
+                               if (ssz != 1 || rhs)
+                                       break;
+
+                               rhs = seq;
+                               rsz = ssz;
+                               break;
+                       default:
+                               rhs = NULL;
+                               break;
+                       }

 
 

-       for (sz = 0; *cp; cp++)
-               sz += (*p->width)(p, *cp);
+                       if (NULL == rhs)
+                               break;
+
+                       for (i = 0; i < rsz; i++)
+                               sz += (*p->width)(p, *rhs++);
+                       break;
+               case (ASCII_NBRSP):
+                       sz += (*p->width)(p, ' ');
+                       cp++;
+                       break;
+               case (ASCII_HYPH):
+                       sz += (*p->width)(p, '-');
+                       cp++;
+                       break;
+               default:
+                       sz += (*p->width)(p, *cp++);
+                       break;
+               }

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