-/* $Id: term.c,v 1.4 2009/02/21 15:34:46 kristaps Exp $ */
+/* $Id: term.c,v 1.91 2009/07/21 13:34:13 kristaps Exp $ */
/*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
* Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <assert.h>
-#include <ctype.h>
-#include <curses.h>
#include <err.h>
-#include <stdlib.h>
#include <stdio.h>
+#include <stdlib.h>
#include <string.h>
-#include <term.h>
-#include <unistd.h>
-
-#include "private.h"
-
-enum termesc {
- ESC_CLEAR,
- ESC_BOLD,
- ESC_UNDERLINE
-};
-
-struct termp {
- size_t rmargin;
- size_t maxrmargin;
- size_t maxcols;
- size_t offset;
- size_t col;
- int flags;
-#define TERMP_BOLD (1 << 0) /* Embolden words. */
-#define TERMP_UNDERLINE (1 << 1) /* Underline words. */
-#define TERMP_NOSPACE (1 << 2) /* No space before words. */
-#define TERMP_NOLPAD (1 << 3) /* No left-padding. */
-#define TERMP_NOBREAK (1 << 4) /* No break after line */
- char *buf;
-};
-
-struct termact {
- int (*pre)(struct termp *,
- const struct mdoc_meta *,
- const struct mdoc_node *);
- int (*post)(struct termp *,
- const struct mdoc_meta *,
- const struct mdoc_node *);
-};
-
-static void termprint_r(struct termp *,
- const struct mdoc_meta *,
- const struct mdoc_node *);
-static void termprint_header(struct termp *,
- const struct mdoc_meta *);
-static void termprint_footer(struct termp *,
- const struct mdoc_meta *);
-
-static int arg_hasattr(int, size_t,
- const struct mdoc_arg *);
-static int arg_getattr(int, size_t,
- const struct mdoc_arg *);
-
-static void newln(struct termp *);
-static void vspace(struct termp *);
-static void pword(struct termp *, const char *, size_t);
-static void word(struct termp *, const char *);
-
-#define decl_prepost(name, suffix) \
-static int name##_##suffix(struct termp *, \
- const struct mdoc_meta *, \
- const struct mdoc_node *)
-
-#define decl_pre(name) decl_prepost(name, pre)
-#define decl_post(name) decl_prepost(name, post)
-
-decl_pre(termp_fl);
-decl_pre(termp_it);
-decl_pre(termp_nd);
-decl_pre(termp_ns);
-decl_pre(termp_op);
-decl_pre(termp_pp);
-decl_pre(termp_sh);
-decl_pre(termp_xr);
-
-decl_post(termp_bl);
-decl_post(termp_it);
-decl_post(termp_op);
-decl_post(termp_sh);
-
-decl_pre(termp_bold);
-decl_pre(termp_under);
-
-decl_post(termp_bold);
-decl_post(termp_under);
-
-const struct termact termacts[MDOC_MAX] = {
- { NULL, NULL }, /* \" */
- { NULL, NULL }, /* Dd */
- { NULL, NULL }, /* Dt */
- { NULL, NULL }, /* Os */
- { termp_sh_pre, termp_sh_post }, /* Sh */
- { NULL, NULL }, /* Ss */
- { termp_pp_pre, NULL }, /* Pp */
- { NULL, NULL }, /* D1 */
- { NULL, NULL }, /* Dl */
- { NULL, NULL }, /* Bd */
- { NULL, NULL }, /* Ed */
- { NULL, termp_bl_post }, /* Bl */
- { NULL, NULL }, /* El */
- { termp_it_pre, termp_it_post }, /* It */
- { NULL, NULL }, /* Ad */
- { NULL, NULL }, /* An */
- { termp_under_pre, termp_under_post }, /* Ar */
- { NULL, NULL }, /* Cd */
- { NULL, NULL }, /* Cm */
- { NULL, NULL }, /* Dv */
- { NULL, NULL }, /* Er */
- { NULL, NULL }, /* Ev */
- { NULL, NULL }, /* Ex */
- { NULL, NULL }, /* Fa */
- { NULL, NULL }, /* Fd */
- { termp_fl_pre, termp_bold_post }, /* Fl */
- { NULL, NULL }, /* Fn */
- { NULL, NULL }, /* Ft */
- { NULL, NULL }, /* Ic */
- { NULL, NULL }, /* In */
- { NULL, NULL }, /* Li */
- { termp_nd_pre, NULL }, /* Nd */
- { termp_bold_pre, termp_bold_post }, /* Nm */
- { termp_op_pre, termp_op_post }, /* Op */
- { NULL, NULL }, /* Ot */
- { NULL, NULL }, /* Pa */
- { NULL, NULL }, /* Rv */
- { NULL, NULL }, /* St */
- { NULL, NULL }, /* Va */
- { NULL, NULL }, /* Vt */
- { termp_xr_pre, NULL }, /* Xr */
- { NULL, NULL }, /* %A */
- { NULL, NULL }, /* %B */
- { NULL, NULL }, /* %D */
- { NULL, NULL }, /* %I */
- { NULL, NULL }, /* %J */
- { NULL, NULL }, /* %N */
- { NULL, NULL }, /* %O */
- { NULL, NULL }, /* %P */
- { NULL, NULL }, /* %R */
- { NULL, NULL }, /* %T */
- { NULL, NULL }, /* %V */
- { NULL, NULL }, /* Ac */
- { NULL, NULL }, /* Ao */
- { NULL, NULL }, /* Aq */
- { NULL, NULL }, /* At */
- { NULL, NULL }, /* Bc */
- { NULL, NULL }, /* Bf */
- { NULL, NULL }, /* Bo */
- { NULL, NULL }, /* Bq */
- { NULL, NULL }, /* Bsx */
- { NULL, NULL }, /* Bx */
- { NULL, NULL }, /* Db */
- { NULL, NULL }, /* Dc */
- { NULL, NULL }, /* Do */
- { NULL, NULL }, /* Dq */
- { NULL, NULL }, /* Ec */
- { NULL, NULL }, /* Ef */
- { NULL, NULL }, /* Em */
- { NULL, NULL }, /* Eo */
- { NULL, NULL }, /* Fx */
- { NULL, NULL }, /* Ms */
- { NULL, NULL }, /* No */
- { termp_ns_pre, NULL }, /* Ns */
- { NULL, NULL }, /* Nx */
- { NULL, NULL }, /* Ox */
- { NULL, NULL }, /* Pc */
- { NULL, NULL }, /* Pf */
- { NULL, NULL }, /* Po */
- { NULL, NULL }, /* Pq */
- { NULL, NULL }, /* Qc */
- { NULL, NULL }, /* Ql */
- { NULL, NULL }, /* Qo */
- { NULL, NULL }, /* Qq */
- { NULL, NULL }, /* Re */
- { NULL, NULL }, /* Rs */
- { NULL, NULL }, /* Sc */
- { NULL, NULL }, /* So */
- { NULL, NULL }, /* Sq */
- { NULL, NULL }, /* Sm */
- { NULL, NULL }, /* Sx */
- { NULL, NULL }, /* Sy */
- { NULL, NULL }, /* Tn */
- { NULL, NULL }, /* Ux */
- { NULL, NULL }, /* Xc */
- { NULL, NULL }, /* Xo */
- { NULL, NULL }, /* Fo */
- { NULL, NULL }, /* Fc */
- { NULL, NULL }, /* Oo */
- { NULL, NULL }, /* Oc */
- { NULL, NULL }, /* Bk */
- { NULL, NULL }, /* Ek */
- { NULL, NULL }, /* Bt */
- { NULL, NULL }, /* Hf */
- { NULL, NULL }, /* Fr */
- { NULL, NULL }, /* Ud */
-};
+#include "term.h"
+#include "man.h"
+#include "mdoc.h"
-static int
-arg_hasattr(int arg, size_t argc, const struct mdoc_arg *argv)
-{
+extern int man_run(struct termp *,
+ const struct man *);
+extern int mdoc_run(struct termp *,
+ const struct mdoc *);
- return(-1 != arg_getattr(arg, argc, argv));
-}
+static struct termp *term_alloc(enum termenc);
+static void term_free(struct termp *);
+static void term_pescape(struct termp *, const char **);
+static void term_nescape(struct termp *,
+ const char *, size_t);
+static void term_chara(struct termp *, char);
+static void term_encodea(struct termp *, char);
+static int term_isopendelim(const char *);
+static int term_isclosedelim(const char *);
-static int
-arg_getattr(int arg, size_t argc, const struct mdoc_arg *argv)
+void *
+ascii_alloc(void)
{
- int i;
- for (i = 0; i < (int)argc; i++)
- if (argv[i].arg == arg)
- return(i);
- return(-1);
+ return(term_alloc(TERMENC_ASCII));
}
-static void
-flushln(struct termp *p)
+int
+terminal_man(void *arg, const struct man *man)
{
- size_t i, j, vsz, vis, maxvis;
+ 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.
- */
-
- 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.
- */
+ p = (struct termp *)arg;
+ if (NULL == p->symtab)
+ p->symtab = term_ascii2htab();
- if ( ! (p->flags & TERMP_NOLPAD))
- /* LINTED */
- for (j = 0; j < p->offset; j++)
- putchar(' ');
-
- for (i = 0; i < p->col; i++) {
- /*
- * Count up visible word characters. Control sequences
- * (starting with the CSI) aren't counted.
- */
- assert( ! isspace(p->buf[i]));
-
- /* LINTED */
- for (j = i, vsz = 0; j < p->col; j++) {
- if (isspace(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 (isspace(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;
+ return(man_run(p, man));
}
-static 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);
-}
-
-
-static void
-vspace(struct termp *p)
+int
+terminal_mdoc(void *arg, const struct mdoc *mdoc)
{
+ struct termp *p;
- /*
- * Asserts a vertical space (a full, empty line-break between
- * lines).
- */
- newln(p);
- putchar('\n');
-}
-
-
-static void
-chara(struct termp *p, char c)
-{
+ p = (struct termp *)arg;
+ if (NULL == p->symtab)
+ p->symtab = term_ascii2htab();
- /* TODO: dynamically expand the buffer. */
- if (p->col + 1 >= p->maxcols)
- errx(1, "line overrun");
- p->buf[(p->col)++] = c;
+ return(mdoc_run(p, mdoc));
}
-static void
-escape(struct termp *p, enum termesc esc)
+void
+terminal_free(void *arg)
{
- if (p->col + 4 >= p->maxcols)
- errx(1, "line overrun");
-
- p->buf[(p->col)++] = 27;
- p->buf[(p->col)++] = '[';
- switch (esc) {
- case (ESC_CLEAR):
- p->buf[(p->col)++] = '0';
- break;
- case (ESC_BOLD):
- p->buf[(p->col)++] = '1';
- break;
- case (ESC_UNDERLINE):
- p->buf[(p->col)++] = '4';
- break;
- default:
- abort();
- /* NOTREACHED */
- }
- p->buf[(p->col)++] = 'm';
+ term_free((struct termp *)arg);
}
static void
-pword(struct termp *p, const char *word, size_t len)
+term_free(struct termp *p)
{
- size_t i;
-
- assert(len > 0);
-
- if ( ! (p->flags & TERMP_NOSPACE))
- chara(p, ' ');
-
- p->flags &= ~TERMP_NOSPACE;
- if (p->flags & TERMP_BOLD)
- escape(p, ESC_BOLD);
- if (p->flags & TERMP_UNDERLINE)
- escape(p, ESC_UNDERLINE);
+ if (p->buf)
+ free(p->buf);
+ if (TERMENC_ASCII == p->enc && p->symtab)
+ term_asciifree(p->symtab);
- /* TODO: escape patterns. */
-
- for (i = 0; i < len; i++)
- chara(p, word[i]);
-
- if (p->flags & TERMP_BOLD ||
- p->flags & TERMP_UNDERLINE)
- escape(p, ESC_CLEAR);
+ free(p);
}
-static void
-word(struct termp *p, const char *word)
+static struct termp *
+term_alloc(enum termenc enc)
{
- size_t i, j, len;
-
- if (mdoc_isdelim(word))
- p->flags |= TERMP_NOSPACE;
-
- len = strlen(word);
- assert(len > 0);
+ struct termp *p;
- /* LINTED */
- for (j = i = 0; i < len; i++) {
- if ( ! isspace(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);
- }
+ if (NULL == (p = malloc(sizeof(struct termp))))
+ err(1, "malloc");
+ bzero(p, sizeof(struct termp));
+ p->maxrmargin = 78;
+ p->enc = enc;
+ return(p);
}
-/* ARGSUSED */
static int
-termp_it_post(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
+term_isclosedelim(const char *p)
{
- const struct mdoc_node *n, *it;
- const struct mdoc_block *bl;
- int i;
- size_t width;
- switch (node->type) {
- case (MDOC_BODY):
+ if ( ! (*p && 0 == *(p + 1)))
+ return(0);
+
+ switch (*p) {
+ case('.'):
/* FALLTHROUGH */
- case (MDOC_HEAD):
- break;
- default:
+ case(','):
+ /* FALLTHROUGH */
+ case(';'):
+ /* FALLTHROUGH */
+ case(':'):
+ /* FALLTHROUGH */
+ case('?'):
+ /* FALLTHROUGH */
+ case('!'):
+ /* FALLTHROUGH */
+ case(')'):
+ /* FALLTHROUGH */
+ case(']'):
+ /* FALLTHROUGH */
+ case('}'):
return(1);
+ default:
+ break;
}
- it = node->parent;
- assert(MDOC_BLOCK == it->type);
- assert(MDOC_It == it->tok);
-
- n = it->parent;
- assert(MDOC_BODY == n->type);
- assert(MDOC_Bl == n->tok);
- n = n->parent;
- bl = &n->data.block;
-
- /* If `-tag', adjust our margins accordingly. */
-
- if (arg_hasattr(MDOC_Tag, bl->argc, bl->argv)) {
- i = arg_getattr(MDOC_Width, bl->argc, bl->argv);
- assert(i >= 0);
- assert(1 == bl->argv[i].sz);
- width = strlen(*bl->argv[i].value); /* XXX */
-
- if (MDOC_HEAD == node->type) {
- flushln(p);
- /* FIXME: nested lists. */
- p->rmargin = p->maxrmargin;
- p->flags &= ~TERMP_NOBREAK;
- } else {
- flushln(p);
- p->offset -= width + 1;
- p->flags &= ~TERMP_NOLPAD;
- }
- }
-
- return(1);
+ return(0);
}
-/* ARGSUSED */
static int
-termp_it_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
+term_isopendelim(const char *p)
{
- const struct mdoc_node *n, *it;
- const struct mdoc_block *bl;
- int i;
- size_t width;
- switch (node->type) {
- case (MDOC_BODY):
- /* FALLTHROUGH */
- case (MDOC_HEAD):
- it = node->parent;
- break;
- case (MDOC_BLOCK):
- it = node;
- break;
- default:
- return(1);
- }
-
- assert(MDOC_BLOCK == it->type);
- assert(MDOC_It == it->tok);
-
- n = it->parent;
- assert(MDOC_BODY == n->type);
- assert(MDOC_Bl == n->tok);
- n = n->parent;
- bl = &n->data.block;
-
- /* If `-compact', don't assert vertical space. */
+ if ( ! (*p && 0 == *(p + 1)))
+ return(0);
- if (MDOC_BLOCK == node->type) {
- if (arg_hasattr(MDOC_Compact, bl->argc, bl->argv))
- newln(p);
- else
- vspace(p);
+ switch (*p) {
+ case('('):
+ /* FALLTHROUGH */
+ case('['):
+ /* FALLTHROUGH */
+ case('{'):
return(1);
+ default:
+ break;
}
- assert(MDOC_HEAD == node->type
- || MDOC_BODY == node->type);
-
- /* If `-tag', adjust our margins accordingly. */
-
- if (arg_hasattr(MDOC_Tag, bl->argc, bl->argv)) {
- i = arg_getattr(MDOC_Width, bl->argc, bl->argv);
- assert(i >= 0); /* XXX */
- assert(1 == bl->argv[i].sz);
- width = strlen(*bl->argv[i].value); /* XXX */
-
- /* FIXME: nested lists. */
-
- if (MDOC_HEAD == node->type) {
- p->flags |= TERMP_NOBREAK;
- p->flags |= TERMP_NOSPACE;
- p->rmargin = p->offset + width;
- } else {
- p->flags |= TERMP_NOSPACE;
- p->flags |= TERMP_NOLPAD;
- p->offset += width + 1;
- }
- }
-
- return(1);
-}
-
-
-/* ARGSUSED */
-static int
-termp_bold_post(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
-
- p->flags &= ~TERMP_BOLD;
- return(1);
-}
-
-
-/* ARGSUSED */
-static int
-termp_under_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
-
- p->flags |= TERMP_UNDERLINE;
- return(1);
+ return(0);
}
-/* ARGSUSED */
-static int
-termp_bold_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
+/*
+ * Flush a line of text. A "line" is loosely defined as being something
+ * that should be followed by a newline, regardless of whether it's
+ * broken apart by newlines getting there. A line can also be a
+ * fragment of a columnar list.
+ *
+ * Specifically, a line is whatever's in p->buf of length p->col, which
+ * is zeroed after this function returns.
+ *
+ * The usage of termp:flags is as follows:
+ *
+ * - 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.
+ *
+ * - 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
+ * when the next invocation.
+ *
+ * In-line line breaking:
+ *
+ * If TERMP_NOBREAK is specified and the line overruns the right
+ * margin, it will break and pad-right to the right margin after
+ * writing. If maxrmargin is violated, it will break and continue
+ * writing from the right-margin, which will lead to the above
+ * scenario upon exit.
+ *
+ * Otherwise, the line will break at the right margin. Extremely long
+ * lines will cause the system to emit a warning (TODO: hyphenate, if
+ * possible).
+ *
+ * FIXME: newline breaks occur (in groff) also occur when a single
+ * space follows a NOBREAK (try `Bl -tag')
+ *
+ * FIXME: there's a newline error where a `Bl -diag' will have a
+ * trailing newline if the line is exactly 73 chars long.
+ */
+void
+term_flushln(struct termp *p)
{
+ int i, j;
+ size_t vbl, vsz, vis, maxvis, mmax, bp;
+ static int overstep = 0;
- p->flags |= TERMP_BOLD;
- return(1);
-}
-
+ /*
+ * 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.
+ */
-/* ARGSUSED */
-static int
-termp_ns_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
+ assert(p->offset < p->rmargin);
+ maxvis = p->rmargin - p->offset - overstep;
+ mmax = p->maxrmargin - p->offset - overstep;
+ bp = TERMP_NOBREAK & p->flags ? mmax : maxvis;
+ vis = 0;
+ overstep = 0;
- p->flags |= TERMP_NOSPACE;
- return(1);
-}
+ /*
+ * 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 < (int)p->offset; j++)
+ putchar(' ');
-/* ARGSUSED */
-static int
-termp_pp_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
+ for (i = 0; i < (int)p->col; i++) {
+ /*
+ * Count up visible word characters. Control sequences
+ * (starting with the CSI) aren't counted. A space
+ * generates a non-printing word, which is valid (the
+ * space is printed according to regular spacing rules).
+ */
- vspace(p);
- return(1);
-}
+ /* LINTED */
+ for (j = i, vsz = 0; j < (int)p->col; j++) {
+ if (' ' == p->buf[j])
+ break;
+ else if (8 == p->buf[j])
+ vsz--;
+ else
+ vsz++;
+ }
+ /*
+ * Choose the number of blanks to prepend: no blank at the
+ * beginning of a line, one between words -- but do not
+ * actually write them yet.
+ */
+ vbl = (size_t)(0 == vis ? 0 : 1);
-/* ARGSUSED */
-static int
-termp_under_post(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
+ /*
+ * Find out whether we would exceed the right margin.
+ * If so, break to the next line. (TODO: hyphenate)
+ * Otherwise, write the chosen number of blanks now.
+ */
+ if (vis && vis + vbl + vsz > bp) {
+ putchar('\n');
+ if (TERMP_NOBREAK & p->flags) {
+ for (j = 0; j < (int)p->rmargin; j++)
+ putchar(' ');
+ vis = p->rmargin - p->offset;
+ } else {
+ for (j = 0; j < (int)p->offset; j++)
+ putchar(' ');
+ vis = 0;
+ }
+ } else {
+ for (j = 0; j < (int)vbl; j++)
+ putchar(' ');
+ vis += vbl;
+ }
- p->flags &= ~TERMP_UNDERLINE;
- return(1);
-}
+ /*
+ * Finally, write out the word.
+ */
+ for ( ; i < (int)p->col; i++) {
+ if (' ' == p->buf[i])
+ break;
+ putchar(p->buf[i]);
+ }
+ vis += vsz;
+ }
+ p->col = 0;
+ if ( ! (TERMP_NOBREAK & p->flags)) {
+ putchar('\n');
+ return;
+ }
-/* ARGSUSED */
-static int
-termp_nd_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
+ if (TERMP_HANG & p->flags) {
- word(p, "-");
- return(1);
-}
+ /* We need one blank after the tag. */
+ overstep = vis - maxvis + 1;
+ /*
+ * 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 (overstep >= -1)
+ maxvis += overstep;
+ else
+ overstep = 0;
-/* ARGSUSED */
-static int
-termp_bl_post(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
+ } else if (TERMP_DANGLE & p->flags)
+ return;
- switch (node->type) {
- case (MDOC_BLOCK):
- newln(p);
- break;
- default:
- break;
+ if (maxvis > vis + ((TERMP_TWOSPACE & p->flags) ? 1 : 0)) /* pad */
+ for ( ; vis < maxvis; vis++)
+ putchar(' ');
+ else { /* break */
+ putchar('\n');
+ for (i = 0; i < (int)p->rmargin; i++)
+ putchar(' ');
}
- return(1);
}
-/* ARGSUSED */
-static int
-termp_op_post(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
+/*
+ * A newline only breaks an existing line; it won't assert vertical
+ * space. All data in the output buffer is flushed prior to the newline
+ * assertion.
+ */
+void
+term_newln(struct termp *p)
{
- switch (node->type) {
- case (MDOC_BODY):
- p->flags |= TERMP_NOSPACE;
- word(p, "\\]");
- break;
- default:
- break;
+ p->flags |= TERMP_NOSPACE;
+ if (0 == p->col) {
+ p->flags &= ~TERMP_NOLPAD;
+ return;
}
- return(1);
+ term_flushln(p);
+ p->flags &= ~TERMP_NOLPAD;
}
-/* ARGSUSED */
-static int
-termp_sh_post(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
+/*
+ * Asserts a vertical space (a full, empty line-break between lines).
+ * Note that if used twice, this will cause two blank spaces and so on.
+ * All data in the output buffer is flushed prior to the newline
+ * assertion.
+ */
+void
+term_vspace(struct termp *p)
{
- switch (node->type) {
- case (MDOC_HEAD):
- p->flags &= ~TERMP_BOLD;
- newln(p);
- break;
- case (MDOC_BODY):
- newln(p);
- p->offset -= 4;
- break;
- default:
- break;
- }
- return(1);
+ term_newln(p);
+ putchar('\n');
}
-/* ARGSUSED */
-static int
-termp_xr_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
+/*
+ * Determine the symbol indicated by an escape sequences, that is, one
+ * starting with a backslash. Once done, we pass this value into the
+ * output buffer by way of the symbol table.
+ */
+static void
+term_nescape(struct termp *p, const char *word, size_t len)
{
- const struct mdoc_node *n;
-
- n = node->child;
- assert(n);
-
- assert(MDOC_TEXT == n->type);
- word(p, n->data.text.string);
-
- if (NULL == (n = n->next))
- return(0);
+ const char *rhs;
+ size_t sz;
+ int i;
- assert(MDOC_TEXT == n->type);
- p->flags |= TERMP_NOSPACE;
- word(p, "\\(");
- p->flags |= TERMP_NOSPACE;
- word(p, n->data.text.string);
- p->flags |= TERMP_NOSPACE;
- word(p, "\\)");
+ rhs = term_a2ascii(p->symtab, word, len, &sz);
- return(0);
+ if (rhs)
+ for (i = 0; i < (int)sz; i++)
+ term_encodea(p, rhs[i]);
}
-/* ARGSUSED */
-static int
-termp_sh_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
+/*
+ * Handle an escape sequence: determine its length and pass it to the
+ * escape-symbol look table. Note that we assume mdoc(3) has validated
+ * the escape sequence (we assert upon badly-formed escape sequences).
+ */
+static void
+term_pescape(struct termp *p, const char **word)
{
+ int j;
+ const char *wp;
- switch (node->type) {
- case (MDOC_HEAD):
- vspace(p);
- p->flags |= TERMP_BOLD;
- break;
- case (MDOC_BODY):
- p->offset += 4;
- break;
- default:
- break;
- }
- return(1);
-}
-
-
-/* ARGSUSED */
-static int
-termp_op_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
+ wp = *word;
- switch (node->type) {
- case (MDOC_BODY):
- word(p, "\\[");
- p->flags |= TERMP_NOSPACE;
- break;
- default:
- break;
+ if (0 == *(++wp)) {
+ *word = wp;
+ return;
}
- return(1);
-}
-
-
-/* ARGSUSED */
-static int
-termp_fl_pre(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
-
- p->flags |= TERMP_BOLD;
- word(p, "-");
- p->flags |= TERMP_NOSPACE;
- return(1);
-}
+ if ('(' == *wp) {
+ wp++;
+ if (0 == *wp || 0 == *(wp + 1)) {
+ *word = 0 == *wp ? wp : wp + 1;
+ return;
+ }
-static void
-termprint_r(struct termp *p, const struct mdoc_meta *meta,
- const struct mdoc_node *node)
-{
- int dochild;
-
- /* Pre-processing ----------------- */
+ term_nescape(p, wp, 2);
+ *word = ++wp;
+ return;
- dochild = 1;
+ } else if ('*' == *wp) {
+ if (0 == *(++wp)) {
+ *word = wp;
+ return;
+ }
- if (MDOC_TEXT != node->type) {
- if (termacts[node->tok].pre)
- if ( ! (*termacts[node->tok].pre)(p, meta, node))
- dochild = 0;
- } else /* MDOC_TEXT == node->type */
- word(p, node->data.text.string);
+ switch (*wp) {
+ case ('('):
+ wp++;
+ if (0 == *wp || 0 == *(wp + 1)) {
+ *word = 0 == *wp ? wp : wp + 1;
+ return;
+ }
- /* Children ---------------------- */
+ term_nescape(p, wp, 2);
+ *word = ++wp;
+ return;
+ case ('['):
+ break;
+ default:
+ term_nescape(p, wp, 1);
+ *word = wp;
+ return;
+ }
+
+ } else if ('f' == *wp) {
+ if (0 == *(++wp)) {
+ *word = wp;
+ return;
+ }
- if (dochild && NULL == node->child) {
- /* No-child processing. */
- switch (node->type) {
- case (MDOC_ELEM):
- switch (node->tok) {
- case (MDOC_Nm):
- word(p, "progname"); /* TODO */
- break;
- case (MDOC_Ar):
- word(p, "...");
- break;
- default:
- break;
- }
+ switch (*wp) {
+ case ('B'):
+ p->flags |= TERMP_BOLD;
+ break;
+ case ('I'):
+ p->flags |= TERMP_UNDER;
+ break;
+ case ('P'):
+ /* FALLTHROUGH */
+ case ('R'):
+ p->flags &= ~TERMP_STYLE;
break;
default:
break;
}
- } else if (dochild)
- termprint_r(p, meta, node->child);
- /* Post-processing --------------- */
+ *word = wp;
+ return;
- if (MDOC_TEXT != node->type) {
- if (termacts[node->tok].post)
- if ( ! (*termacts[node->tok].post)(p, meta, node))
- return;
- }
+ } else if ('[' != *wp) {
+ term_nescape(p, wp, 1);
+ *word = wp;
+ return;
+ }
- /* Siblings ---------------------- */
+ wp++;
+ for (j = 0; *wp && ']' != *wp; wp++, j++)
+ /* Loop... */ ;
- if (node->next)
- termprint_r(p, meta, node->next);
+ if (0 == *wp) {
+ *word = wp;
+ return;
+ }
+
+ term_nescape(p, wp - j, (size_t)j);
+ *word = wp;
}
-static void
-termprint_footer(struct termp *p, const struct mdoc_meta *meta)
+/*
+ * Handle pwords, partial words, which may be either a single word or a
+ * phrase that cannot be broken down (such as a literal string). This
+ * handles word styling.
+ */
+void
+term_word(struct termp *p, const char *word)
{
- struct tm *tm;
- char *buf, *os;
- size_t sz, osz, ssz, i;
+ const char *sv;
- if (NULL == (buf = malloc(p->rmargin)))
- err(1, "malloc");
- if (NULL == (os = malloc(p->rmargin)))
- err(1, "malloc");
-
- tm = localtime(&meta->date);
- if (NULL == strftime(buf, p->rmargin, "%B %d, %Y", tm))
- err(1, "strftime");
-
- osz = strlcpy(os, meta->os, p->rmargin);
+ if (term_isclosedelim(word))
+ if ( ! (TERMP_IGNDELIM & p->flags))
+ p->flags |= TERMP_NOSPACE;
- sz = strlen(buf);
- ssz = sz + osz + 1;
+ if ( ! (TERMP_NOSPACE & p->flags))
+ term_chara(p, ' ');
- if (ssz > p->rmargin) {
- ssz -= p->rmargin;
- assert(ssz <= osz);
- os[osz - ssz] = 0;
- ssz = 1;
- } else
- ssz = p->rmargin - ssz + 1;
+ if ( ! (p->flags & TERMP_NONOSPACE))
+ p->flags &= ~TERMP_NOSPACE;
- printf("\n");
- printf("%s", os);
- for (i = 0; i < ssz; i++)
- printf(" ");
+ /*
+ * If ANSI (word-length styling), then apply our style now,
+ * before the word.
+ */
- printf("%s\n", buf);
- fflush(stdout);
+ for (sv = word; *word; word++)
+ if ('\\' != *word)
+ term_encodea(p, *word);
+ else
+ term_pescape(p, &word);
- free(buf);
- free(os);
+ if (term_isopendelim(sv))
+ p->flags |= TERMP_NOSPACE;
}
+/*
+ * Insert a single character into the line-buffer. If the buffer's
+ * space is exceeded, then allocate more space by doubling the buffer
+ * size.
+ */
static void
-termprint_header(struct termp *p, const struct mdoc_meta *meta)
+term_chara(struct termp *p, char c)
{
- char *msec, *buf, *title, *pp;
- 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);
+ size_t s;
+
+ if (p->col + 1 >= p->maxcols) {
+ if (0 == p->maxcols)
+ p->maxcols = 256;
+ s = p->maxcols * 2;
+ p->buf = realloc(p->buf, s);
+ if (NULL == p->buf)
+ err(1, "realloc");
+ p->maxcols = s;
}
-
- 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);
+ p->buf[(int)(p->col)++] = c;
}
-int
-termprint(const struct mdoc_node *node,
- const struct mdoc_meta *meta)
+static void
+term_encodea(struct termp *p, char c)
{
- struct termp p;
-
- if (ERR == setupterm(NULL, STDOUT_FILENO, NULL))
- return(0);
-
- p.maxrmargin = columns < 60 ? 60 : (size_t)columns;
- p.rmargin = p.maxrmargin;
- p.maxcols = 1024;
- p.offset = p.col = 0;
- p.flags = TERMP_NOSPACE;
-
- if (NULL == (p.buf = malloc(p.maxcols)))
- err(1, "malloc");
-
- termprint_header(&p, meta);
- termprint_r(&p, meta, node);
- termprint_footer(&p, meta);
-
- free(p.buf);
-
- return(1);
+
+ if (' ' != c && TERMP_STYLE & p->flags) {
+ if (TERMP_BOLD & p->flags) {
+ term_chara(p, c);
+ term_chara(p, 8);
+ }
+ if (TERMP_UNDER & p->flags) {
+ term_chara(p, '_');
+ term_chara(p, 8);
+ }
+ }
+ term_chara(p, c);
}
-
-