]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdocterm.c
Formatting.
[mandoc.git] / mdocterm.c
index 58350fec495a5cbfea6ebecc30b5356166ce8066..a8a06c1288866645f19a9ddd79063674dcf1ae08 100644 (file)
@@ -1,4 +1,4 @@
-       /* $Id: mdocterm.c,v 1.2 2009/02/22 22:58:39 kristaps Exp $ */
+       /* $Id: mdocterm.c,v 1.10 2009/02/25 12:27:37 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
  * PERFORMANCE OF THIS SOFTWARE.
  */
 #include <assert.h>
+#include <ctype.h>
 #include <err.h>
 #include <getopt.h>
+#include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
+
+#ifndef __OpenBSD__
+#include <time.h>
+#endif
 
 #include "mmain.h"
 #include "term.h"
 
+#ifdef __NetBSD__
+#define xisspace(x) isspace((int)(x))
+#else
+#define        xisspace(x) isspace((x))
+#endif
+
+enum   termstyle {
+       STYLE_CLEAR,
+       STYLE_BOLD,
+       STYLE_UNDERLINE
+};
+
+static void              body(struct termp *,
+                               const struct mdoc_meta *,
+                               const struct mdoc_node *);
+static void              header(struct termp *,
+                               const struct mdoc_meta *);
+static void              footer(struct termp *,
+                               const struct mdoc_meta *);
+
+static void              pword(struct termp *, const char *, size_t);
+static void              pescape(struct termp *, 
+                               const char *, size_t *, size_t);
+static void              chara(struct termp *, char);
+static void              stringa(struct termp *, const char *);
+static void              style(struct termp *, enum termstyle);
+
+#ifdef __linux__
+extern size_t            strlcat(char *, const char *, size_t);
+extern size_t            strlcpy(char *, const char *, size_t);
+#endif
+
+
 int
 main(int argc, char *argv[])
 {
        struct mmain    *p;
        const struct mdoc *mdoc;
-       int              c;
-
-       extern int       optreset;
-       extern int       optind;
+       struct termp     termp;
 
        p = mmain_alloc();
 
-       if ( ! mmain_getopt(p, argc, argv, ""))
+       if ( ! mmain_getopt(p, argc, argv, NULL, NULL, NULL, NULL))
                mmain_exit(p, 1);
 
-       optreset = optind = 1;
-
-       while (-1 != (c = getopt(argc, argv, "")))
-               switch (c) {
-               default:
-                       mmain_usage("");
-                       mmain_exit(p, 1);
-                       /* NOTREACHED */
-               }
-
        if (NULL == (mdoc = mmain_mdoc(p)))
                mmain_exit(p, 1);
 
-       termprint(mdoc_node(mdoc), mdoc_meta(mdoc));
+       termp.maxrmargin = 80; /* XXX */
+       termp.rmargin = termp.maxrmargin;
+       termp.maxcols = 1024;
+       termp.offset = termp.col = 0;
+       termp.flags = TERMP_NOSPACE;
+
+       if (NULL == (termp.buf = malloc(termp.maxcols)))
+               err(1, "malloc");
+
+       header(&termp, mdoc_meta(mdoc));
+       body(&termp, mdoc_meta(mdoc), mdoc_node(mdoc));
+       footer(&termp, mdoc_meta(mdoc));
+
+       free(termp.buf);
+
        mmain_exit(p, 0);
        /* NOTREACHED */
 }
 
 
+void
+flushln(struct termp *p)
+{
+       size_t           i, j, vsz, vis, maxvis;
+
+       /*
+        * 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.
+        */
+
+       assert(p->offset < p->rmargin);
+       maxvis = p->rmargin - p->offset;
+       vis = 0;
+
+       /*
+        * If in the standard case (left-justified), then begin with our
+        * indentation, otherwise (columns, etc.) just start spitting
+        * out text.
+        */
+
+       if ( ! (p->flags & TERMP_NOLPAD))
+               /* LINTED */
+               for (j = 0; j < p->offset; j++)
+                       putchar(' ');
+
+       /*
+        * If we're literal, print out verbatim.
+        */
+       if (p->flags & TERMP_LITERAL) {
+               /* FIXME: count non-printing chars. */
+               for (i = 0; i < p->col; i++)
+                       putchar(p->buf[i]);
+               putchar('\n');
+               p->col = 0;
+               return;
+       }
+
+       for (i = 0; i < p->col; i++) {
+               /*
+                * Count up visible word characters.  Control sequences
+                * (starting with the CSI) aren't counted. 
+                */
+               assert( ! xisspace(p->buf[i]));
+
+               /* LINTED */
+               for (j = i, vsz = 0; j < p->col; j++) {
+                       if (xisspace(p->buf[j]))
+                               break;
+                       else if (27 == p->buf[j]) {
+                               assert(j + 4 <= p->col);
+                               j += 3;
+                       } else
+                               vsz++;
+               }
+               assert(vsz > 0);
+
+               /*
+                * If a word is too long and we're within a line, put it
+                * on the next line.  Puke if we're being asked to write
+                * something that will exceed the right margin (i.e.,
+                * from a fresh line or when we're not allowed to break
+                * the line with TERMP_NOBREAK).
+                */
+
+               if (vis && vis + vsz >= maxvis) {
+                       /* FIXME */
+                       if (p->flags & TERMP_NOBREAK)
+                               errx(1, "word breaks right margin");
+                       putchar('\n');
+                       for (j = 0; j < p->offset; j++)
+                               putchar(' ');
+                       vis = 0;
+               } else if (vis + vsz >= maxvis)
+                       /* FIXME */
+                       errx(1, "word breaks right margin");
+
+               /* 
+                * Write out the word and a trailing space.  Omit the
+                * space if we're the last word in the line.
+                */
+
+               for ( ; i < p->col; i++) {
+                       if (xisspace(p->buf[i]))
+                               break;
+                       putchar(p->buf[i]);
+               }
+               vis += vsz;
+               if (i < p->col) {
+                       putchar(' ');
+                       vis++;
+               }
+       }
+
+       /*
+        * If we're not to right-marginalise it (newline), then instead
+        * pad to the right margin and stay off.
+        */
+
+       if (p->flags & TERMP_NOBREAK) {
+               for ( ; vis <= maxvis; vis++)
+                       putchar(' ');
+       } else
+               putchar('\n');
+
+       p->col = 0;
+}
+
+
+void
+newln(struct termp *p)
+{
+
+       /* 
+        * A newline only breaks an existing line; it won't assert
+        * vertical space.
+        */
+       p->flags |= TERMP_NOSPACE;
+       if (0 == p->col) 
+               return;
+       flushln(p);
+}
+
+
+void
+vspace(struct termp *p)
+{
+
+       /*
+        * Asserts a vertical space (a full, empty line-break between
+        * lines).
+        */
+       newln(p);
+       putchar('\n');
+}
+
+
+static void
+stringa(struct termp *p, const char *s)
+{
+
+       /* XXX - speed up if not passing to chara. */
+       for ( ; *s; s++)
+               chara(p, *s);
+}
+
+
+static void
+chara(struct termp *p, char c)
+{
+
+       /* TODO: dynamically expand the buffer. */
+       if (p->col + 1 >= p->maxcols)
+               errx(1, "line overrun");
+       p->buf[(p->col)++] = c;
+}
+
+
+static void
+style(struct termp *p, enum termstyle esc)
+{
+
+       if (p->col + 4 >= p->maxcols)
+               errx(1, "line overrun");
+
+       p->buf[(p->col)++] = 27;
+       p->buf[(p->col)++] = '[';
+       switch (esc) {
+       case (STYLE_CLEAR):
+               p->buf[(p->col)++] = '0';
+               break;
+       case (STYLE_BOLD):
+               p->buf[(p->col)++] = '1';
+               break;
+       case (STYLE_UNDERLINE):
+               p->buf[(p->col)++] = '4';
+               break;
+       default:
+               abort();
+               /* NOTREACHED */
+       }
+       p->buf[(p->col)++] = 'm';
+}
+
+
+static void
+pescape(struct termp *p, const char *word, size_t *i, size_t len)
+{
+
+       (*i)++;
+       assert(*i < len);
+
+       if ('(' == word[*i]) {
+               /* Two-character escapes. */
+               (*i)++;
+               assert(*i + 1 < len);
+
+               if ('r' == word[*i] && 'B' == word[*i + 1])
+                       chara(p, ']');
+               else if ('l' == word[*i] && 'B' == word[*i + 1])
+                       chara(p, '[');
+               else if ('<' == word[*i] && '-' == word[*i + 1])
+                       stringa(p, "<-");
+               else if ('-' == word[*i] && '>' == word[*i + 1])
+                       stringa(p, "->");
+               else if ('l' == word[*i] && 'q' == word[*i + 1])
+                       chara(p, '\"');
+               else if ('r' == word[*i] && 'q' == word[*i + 1])
+                       chara(p, '\"');
+
+               (*i)++;
+               return;
+
+       } else if ('[' != word[*i]) {
+               /* One-character escapes. */
+               switch (word[*i]) {
+               case ('\\'):
+                       /* FALLTHROUGH */
+               case ('\''):
+                       /* FALLTHROUGH */
+               case ('`'):
+                       /* FALLTHROUGH */
+               case ('-'):
+                       /* FALLTHROUGH */
+               case ('.'):
+                       chara(p, word[*i]);
+               default:
+                       break;
+               }
+               return;
+       }
+       /* n-character escapes. */
+}
+
+
+static void
+pword(struct termp *p, const char *word, size_t len)
+{
+       size_t           i;
+
+       /*assert(len > 0);*/ /* Can be, if literal. */
+
+       if ( ! (p->flags & TERMP_NOSPACE) && 
+                       ! (p->flags & TERMP_LITERAL))
+               chara(p, ' ');
+
+       p->flags &= ~TERMP_NOSPACE;
+
+       if (p->flags & TERMP_BOLD)
+               style(p, STYLE_BOLD);
+       if (p->flags & TERMP_UNDERLINE)
+               style(p, STYLE_UNDERLINE);
+
+       for (i = 0; i < len; i++) {
+               if ('\\' == word[i]) {
+                       pescape(p, word, &i, len);
+                       continue;
+               }
+               chara(p, word[i]);
+       }
+
+       if (p->flags & TERMP_BOLD ||
+                       p->flags & TERMP_UNDERLINE)
+               style(p, STYLE_CLEAR);
+}
+
+
+void
+word(struct termp *p, const char *word)
+{
+       size_t           i, j, len;
+
+       if (p->flags & TERMP_LITERAL) {
+               pword(p, word, strlen(word));
+               return;
+       }
+
+       len = strlen(word);
+       assert(len > 0);
+
+       if (mdoc_isdelim(word)) {
+               if ( ! (p->flags & TERMP_IGNDELIM))
+                       p->flags |= TERMP_NOSPACE;
+               p->flags &= ~TERMP_IGNDELIM;
+       }
+
+       /* LINTED */
+       for (j = i = 0; i < len; i++) {
+               if ( ! xisspace(word[i])) {
+                       j++;
+                       continue;
+               }
+               if (0 == j)
+                       continue;
+               assert(i >= j);
+               pword(p, &word[i - j], j);
+               j = 0;
+       }
+       if (j > 0) {
+               assert(i >= j);
+               pword(p, &word[i - j], j);
+       }
+}
+
+
+static void
+body(struct termp *p, const struct mdoc_meta *meta,
+               const struct mdoc_node *node)
+{
+       int              dochild;
+       struct termpair  pair;
+
+       /* Pre-processing. */
+
+       dochild = 1;
+       pair.type = 0;
+       pair.offset = 0;
+       pair.flag = 0;
+
+       if (MDOC_TEXT != node->type) {
+               if (termacts[node->tok].pre)
+                       if ( ! (*termacts[node->tok].pre)(p, &pair, meta, node))
+                               dochild = 0;
+       } else /* MDOC_TEXT == node->type */
+               word(p, node->data.text.string);
+
+       /* Children. */
+
+       if (TERMPAIR_FLAG & pair.type)
+               p->flags |= pair.flag;
+
+       if (dochild && node->child)
+               body(p, meta, node->child);
+
+       if (TERMPAIR_FLAG & pair.type)
+               p->flags &= ~pair.flag;
+
+       /* Post-processing. */
+
+       if (MDOC_TEXT != node->type)
+               if (termacts[node->tok].post)
+                       (*termacts[node->tok].post)(p, &pair, meta, node);
+
+       /* Siblings. */
+
+       if (node->next)
+               body(p, meta, node->next);
+}
+
+
+static void
+footer(struct termp *p, const struct mdoc_meta *meta)
+{
+       struct tm       *tm;
+       char            *buf, *os;
+       size_t           sz, osz, ssz, i;
+
+       if (NULL == (buf = malloc(p->rmargin)))
+               err(1, "malloc");
+       if (NULL == (os = malloc(p->rmargin)))
+               err(1, "malloc");
+
+       tm = localtime(&meta->date);
+
+#ifdef __OpenBSD__
+       if (NULL == strftime(buf, p->rmargin, "%B %d, %Y", tm))
+#else
+       if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm))
+#endif
+               err(1, "strftime");
+
+       osz = strlcpy(os, meta->os, p->rmargin);
+
+       sz = strlen(buf);
+       ssz = sz + osz + 1;
+
+       if (ssz > p->rmargin) {
+               ssz -= p->rmargin;
+               assert(ssz <= osz);
+               os[osz - ssz] = 0;
+               ssz = 1;
+       } else
+               ssz = p->rmargin - ssz + 1;
+
+       printf("\n");
+       printf("%s", os);
+       for (i = 0; i < ssz; i++)
+               printf(" ");
+
+       printf("%s\n", buf);
+       fflush(stdout);
+
+       free(buf);
+       free(os);
+}
+
+
+static void
+header(struct termp *p, const struct mdoc_meta *meta)
+{
+       char            *buf, *title;
+       const char      *pp, *msec;
+       size_t           ssz, tsz, ttsz, i;;
+
+       if (NULL == (buf = malloc(p->rmargin)))
+               err(1, "malloc");
+       if (NULL == (title = malloc(p->rmargin)))
+               err(1, "malloc");
+
+       if (NULL == (pp = mdoc_vol2a(meta->vol)))
+               switch (meta->msec) {
+               case (MSEC_1):
+                       /* FALLTHROUGH */
+               case (MSEC_6):
+                       /* FALLTHROUGH */
+               case (MSEC_7):
+                       pp = mdoc_vol2a(VOL_URM);
+                       break;
+               case (MSEC_8):
+                       pp = mdoc_vol2a(VOL_SMM);
+                       break;
+               case (MSEC_2):
+                       /* FALLTHROUGH */
+               case (MSEC_3):
+                       /* FALLTHROUGH */
+               case (MSEC_4):
+                       /* FALLTHROUGH */
+               case (MSEC_5):
+                       pp = mdoc_vol2a(VOL_PRM);
+                       break;
+               case (MSEC_9):
+                       pp = mdoc_vol2a(VOL_KM);
+                       break;
+               default:
+                       /* FIXME: capitalise. */
+                       if (NULL == (pp = mdoc_msec2a(meta->msec)))
+                               pp = mdoc_msec2a(MSEC_local);
+                       break;
+               }
+       assert(pp);
+
+       tsz = strlcpy(buf, pp, p->rmargin);
+       assert(tsz < p->rmargin);
+
+       if ((pp = mdoc_arch2a(meta->arch))) {
+               tsz = strlcat(buf, " (", p->rmargin);
+               assert(tsz < p->rmargin);
+               tsz = strlcat(buf, pp, p->rmargin);
+               assert(tsz < p->rmargin);
+               tsz = strlcat(buf, ")", p->rmargin);
+               assert(tsz < p->rmargin);
+       }
+
+       ttsz = strlcpy(title, meta->title, p->rmargin);
+
+       if (NULL == (msec = mdoc_msec2a(meta->msec)))
+               msec = "";
+
+       ssz = (2 * (ttsz + 2 + strlen(msec))) + tsz + 2;
+
+       if (ssz > p->rmargin) {
+               if ((ssz -= p->rmargin) % 2)
+                       ssz++;
+               ssz /= 2;
+       
+               assert(ssz <= ttsz);
+               title[ttsz - ssz] = 0;
+               ssz = 1;
+       } else
+               ssz = ((p->rmargin - ssz) / 2) + 1;
+
+       printf("%s(%s)", title, msec);
+
+       for (i = 0; i < ssz; i++)
+               printf(" ");
+
+       printf("%s", buf);
+
+       for (i = 0; i < ssz; i++)
+               printf(" ");
+
+       printf("%s(%s)\n", title, msec);
+       fflush(stdout);
+
+       free(title);
+       free(buf);
+}