-/* $Id: man_term.c,v 1.21 2009/08/13 12:31:50 kristaps Exp $ */
+/* $Id: man_term.c,v 1.31 2009/09/16 09:41:24 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#include <sys/types.h>
+
#include <assert.h>
#include <ctype.h>
#include <err.h>
#define INDENT 7
#define HALFINDENT 3
-#ifdef __linux__
-extern size_t strlcpy(char *, const char *, size_t);
-extern size_t strlcat(char *, const char *, size_t);
-#endif
-
+struct mtermp {
+ int fl;
#define MANT_LITERAL (1 << 0)
+ /*
+ * Default amount to indent the left margin after leading text
+ * has been printed (e.g., `HP' left-indent, `TP' and `IP' body
+ * indent). This needs to be saved because `HP' and so on, if
+ * not having a specified value, must default.
+ *
+ * Note that this is the indentation AFTER the left offset, so
+ * the total offset is usually offset + lmargin.
+ */
+ size_t lmargin;
+ /*
+ * The default offset, i.e., the amount between any text and the
+ * page boundary.
+ */
+ size_t offset;
+};
#define DECL_ARGS struct termp *p, \
- int *fl, \
+ struct mtermp *mt, \
const struct man_node *n, \
const struct man_meta *m
static int pre_PP(DECL_ARGS);
static int pre_RB(DECL_ARGS);
static int pre_RI(DECL_ARGS);
+static int pre_RS(DECL_ARGS);
static int pre_SH(DECL_ARGS);
static int pre_SS(DECL_ARGS);
static int pre_TP(DECL_ARGS);
static int pre_br(DECL_ARGS);
static int pre_fi(DECL_ARGS);
+static int pre_ign(DECL_ARGS);
static int pre_nf(DECL_ARGS);
static int pre_r(DECL_ARGS);
static int pre_sp(DECL_ARGS);
static void post_B(DECL_ARGS);
static void post_I(DECL_ARGS);
+static void post_IP(DECL_ARGS);
static void post_HP(DECL_ARGS);
+static void post_RS(DECL_ARGS);
static void post_SH(DECL_ARGS);
static void post_SS(DECL_ARGS);
static void post_TP(DECL_ARGS);
{ pre_PP, NULL }, /* LP */
{ pre_PP, NULL }, /* PP */
{ pre_PP, NULL }, /* P */
- { pre_IP, NULL }, /* IP */
+ { pre_IP, post_IP }, /* IP */
{ pre_HP, post_HP }, /* HP */
{ NULL, NULL }, /* SM */
{ pre_B, post_B }, /* SB */
{ pre_I, post_I }, /* I */
{ pre_IR, NULL }, /* IR */
{ pre_RI, NULL }, /* RI */
- { NULL, NULL }, /* na */ /* TODO: document that has no effect */
+ { NULL, NULL }, /* na */
{ pre_I, post_i }, /* i */
{ pre_sp, NULL }, /* sp */
{ pre_nf, NULL }, /* nf */
{ pre_fi, NULL }, /* fi */
{ pre_r, NULL }, /* r */
+ { NULL, NULL }, /* RE */
+ { pre_RS, post_RS }, /* RS */
+ { pre_ign, NULL }, /* DT */
+ { pre_ign, NULL }, /* UC */
};
+#ifdef __linux__
+extern size_t strlcpy(char *, const char *, size_t);
+extern size_t strlcat(char *, const char *, size_t);
+#endif
+
static void print_head(struct termp *,
const struct man_meta *);
static void print_body(DECL_ARGS);
static int arg_width(const struct man_node *);
-int
+void
man_run(struct termp *p, const struct man *m)
{
- int fl;
+ struct mtermp mt;
print_head(p, man_meta(m));
p->flags |= TERMP_NOSPACE;
- assert(man_node(m));
- assert(MAN_ROOT == man_node(m)->type);
- fl = 0;
+ mt.fl = 0;
+ mt.lmargin = INDENT;
+ mt.offset = INDENT;
+
if (man_node(m)->child)
- print_body(p, &fl, man_node(m)->child, man_meta(m));
+ print_body(p, &mt, man_node(m)->child, man_meta(m));
print_foot(p, man_meta(m));
-
- return(1);
}
}
+/* ARGSUSED */
+static int
+pre_ign(DECL_ARGS)
+{
+
+ return(0);
+}
+
+
/* ARGSUSED */
static int
pre_I(DECL_ARGS)
{
- p->flags |= TERMP_UNDER;
+ p->under++;
return(1);
}
pre_r(DECL_ARGS)
{
- p->flags &= ~TERMP_UNDER;
- p->flags &= ~TERMP_BOLD;
+ p->bold = p->under = 0;
return(1);
}
{
if (n->nchild)
- p->flags &= ~TERMP_UNDER;
+ p->under--;
}
post_I(DECL_ARGS)
{
- p->flags &= ~TERMP_UNDER;
+ p->under--;
}
pre_fi(DECL_ARGS)
{
- *fl &= ~MANT_LITERAL;
+ mt->fl &= ~MANT_LITERAL;
return(1);
}
{
term_newln(p);
- *fl |= MANT_LITERAL;
+ mt->fl |= MANT_LITERAL;
return(1);
}
for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
if ( ! (i % 2))
- p->flags |= TERMP_UNDER;
+ p->under++;
if (i > 0)
p->flags |= TERMP_NOSPACE;
- print_node(p, fl, nn, m);
+ print_node(p, mt, nn, m);
if ( ! (i % 2))
- p->flags &= ~TERMP_UNDER;
+ p->under--;
}
return(0);
}
int i;
for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
- p->flags |= i % 2 ? TERMP_BOLD : TERMP_UNDER;
+ if (i % 2)
+ p->bold++;
+ else
+ p->under++;
if (i > 0)
p->flags |= TERMP_NOSPACE;
- print_node(p, fl, nn, m);
- p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER;
+ print_node(p, mt, nn, m);
+ if (i % 2)
+ p->bold--;
+ else
+ p->under--;
}
return(0);
}
for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
if (i % 2)
- p->flags |= TERMP_BOLD;
+ p->bold++;
if (i > 0)
p->flags |= TERMP_NOSPACE;
- print_node(p, fl, nn, m);
+ print_node(p, mt, nn, m);
if (i % 2)
- p->flags &= ~TERMP_BOLD;
+ p->bold--;
}
return(0);
}
for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
if ( ! (i % 2))
- p->flags |= TERMP_UNDER;
+ p->under++;
if (i > 0)
p->flags |= TERMP_NOSPACE;
- print_node(p, fl, nn, m);
+ print_node(p, mt, nn, m);
if ( ! (i % 2))
- p->flags &= ~TERMP_UNDER;
+ p->under--;
}
return(0);
}
for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
if ( ! (i % 2))
- p->flags |= TERMP_BOLD;
+ p->bold++;
if (i > 0)
p->flags |= TERMP_NOSPACE;
- print_node(p, fl, nn, m);
+ print_node(p, mt, nn, m);
if ( ! (i % 2))
- p->flags &= ~TERMP_BOLD;
+ p->bold--;
}
return(0);
}
int i;
for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
- p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD;
+ if (i % 2)
+ p->under++;
+ else
+ p->bold++;
if (i > 0)
p->flags |= TERMP_NOSPACE;
- print_node(p, fl, nn, m);
- p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD;
+ print_node(p, mt, nn, m);
+ if (i % 2)
+ p->under--;
+ else
+ p->bold--;
}
return(0);
}
pre_B(DECL_ARGS)
{
- p->flags |= TERMP_BOLD;
+ p->bold++;
return(1);
}
post_B(DECL_ARGS)
{
- p->flags &= ~TERMP_BOLD;
+ p->bold--;
}
static int
pre_HP(DECL_ARGS)
{
+ size_t len;
+ int ival;
+ const struct man_node *nn;
switch (n->type) {
case (MAN_BLOCK):
fmt_block_vspace(p, n);
- break;
+ return(1);
case (MAN_BODY):
p->flags |= TERMP_NOBREAK;
p->flags |= TERMP_TWOSPACE;
- p->offset = INDENT;
- p->rmargin = INDENT * 2;
break;
default:
return(0);
}
+ len = mt->lmargin;
+ ival = -1;
+
+ /* Calculate offset. */
+
+ if (NULL != (nn = n->parent->head->child))
+ if ((ival = arg_width(nn)) >= 0)
+ len = (size_t)ival;
+
+ if (0 == len)
+ len = 1;
+
+ p->offset = mt->offset;
+ p->rmargin = mt->offset + len;
+
+ if (ival >= 0)
+ mt->lmargin = (size_t)ival;
+
return(1);
}
{
switch (n->type) {
+ case (MAN_BLOCK):
+ term_flushln(p);
+ break;
case (MAN_BODY):
term_flushln(p);
p->flags &= ~TERMP_NOBREAK;
p->flags &= ~TERMP_TWOSPACE;
- p->offset = INDENT;
+ p->offset = mt->offset;
p->rmargin = p->maxrmargin;
break;
default:
switch (n->type) {
case (MAN_BLOCK):
+ mt->lmargin = INDENT;
fmt_block_vspace(p, n);
break;
default:
- p->offset = INDENT;
+ p->offset = mt->offset;
break;
}
static int
pre_IP(DECL_ARGS)
{
- /* TODO */
-#if 0
- const struct man_node *nn;
- size_t offs, sv;
- int ival;
-
- fmt_block_vspace(p, n);
-
- p->flags |= TERMP_NOSPACE;
-
- sv = p->offset;
- p->offset = INDENT;
+ const struct man_node *nn;
+ size_t len;
+ int ival;
- if (NULL == n->child)
+ switch (n->type) {
+ case (MAN_BODY):
+ p->flags |= TERMP_NOLPAD;
+ p->flags |= TERMP_NOSPACE;
+ break;
+ case (MAN_HEAD):
+ p->flags |= TERMP_NOBREAK;
+ p->flags |= TERMP_TWOSPACE;
+ break;
+ case (MAN_BLOCK):
+ fmt_block_vspace(p, n);
+ /* FALLTHROUGH */
+ default:
return(1);
+ }
- p->flags |= TERMP_NOBREAK;
+ len = mt->lmargin;
+ ival = -1;
- offs = sv;
+ /* Calculate offset. */
- /*
- * If the last token is number-looking (3m, 3n, 3) then
- * interpret it as the width specifier, else we stick with the
- * prior saved offset. XXX - obviously not documented.
- */
- for (nn = n->child; nn; nn = nn->next) {
- if (NULL == nn->next) {
- ival = arg_width(nn);
- if (ival >= 0) {
- offs = (size_t)ival;
- break;
- }
+ if (NULL != (nn = n->parent->head->child))
+ if (NULL != (nn = nn->next)) {
+ for ( ; nn->next; nn = nn->next)
+ /* Do nothing. */ ;
+ if ((ival = arg_width(nn)) >= 0)
+ len = (size_t)ival;
}
- print_node(p, fl, nn, m);
- }
- p->rmargin = p->offset + offs;
+ switch (n->type) {
+ case (MAN_HEAD):
+ /* Handle zero-width lengths. */
+ if (0 == len)
+ len = 1;
- term_flushln(p);
+ p->offset = mt->offset;
+ p->rmargin = mt->offset + len;
+ if (ival < 0)
+ break;
- p->offset = offs;
- p->rmargin = p->maxrmargin;
+ /* Set the saved left-margin. */
+ mt->lmargin = (size_t)ival;
- p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
+ /* Don't print the length value. */
+ for (nn = n->child; nn->next; nn = nn->next)
+ print_node(p, mt, nn, m);
+ return(0);
+ case (MAN_BODY):
+ p->offset = mt->offset + len;
+ p->rmargin = p->maxrmargin;
+ break;
+ default:
+ break;
+ }
- return(0);
-#endif
return(1);
}
+/* ARGSUSED */
+static void
+post_IP(DECL_ARGS)
+{
+
+ switch (n->type) {
+ case (MAN_HEAD):
+ term_flushln(p);
+ p->flags &= ~TERMP_NOBREAK;
+ p->flags &= ~TERMP_TWOSPACE;
+ p->rmargin = p->maxrmargin;
+ break;
+ case (MAN_BODY):
+ term_flushln(p);
+ p->flags &= ~TERMP_NOLPAD;
+ break;
+ default:
+ break;
+ }
+}
+
+
/* ARGSUSED */
static int
pre_TP(DECL_ARGS)
{
+ const struct man_node *nn;
+ size_t len;
+ int ival;
switch (n->type) {
- case (MAN_BLOCK):
- fmt_block_vspace(p, n);
- break;
case (MAN_HEAD):
- p->rmargin = INDENT * 2;
- p->offset = INDENT;
p->flags |= TERMP_NOBREAK;
p->flags |= TERMP_TWOSPACE;
break;
case (MAN_BODY):
p->flags |= TERMP_NOLPAD;
p->flags |= TERMP_NOSPACE;
- p->offset = INDENT * 2;
+ break;
+ case (MAN_BLOCK):
+ fmt_block_vspace(p, n);
+ /* FALLTHROUGH */
+ default:
+ return(1);
+ }
+
+ len = (size_t)mt->lmargin;
+ ival = -1;
+
+ /* Calculate offset. */
+
+ if (NULL != (nn = n->parent->head->child))
+ if (NULL != nn->next)
+ if ((ival = arg_width(nn)) >= 0)
+ len = (size_t)ival;
+
+ switch (n->type) {
+ case (MAN_HEAD):
+ /* Handle zero-length properly. */
+ if (0 == len)
+ len = 1;
+
+ p->offset = mt->offset;
+ p->rmargin = mt->offset + len;
+
+ /* Don't print same-line elements. */
+ for (nn = n->child; nn; nn = nn->next)
+ if (nn->line > n->line)
+ print_node(p, mt, nn, m);
+
+ if (ival >= 0)
+ mt->lmargin = (size_t)ival;
+
+ return(0);
+ case (MAN_BODY):
+ p->offset = mt->offset + len;
+ p->rmargin = p->maxrmargin;
break;
default:
break;
switch (n->type) {
case (MAN_BLOCK):
- term_newln(p);
- if (n->prev)
- term_vspace(p);
+ mt->lmargin = INDENT;
+ mt->offset = INDENT;
+ /* If following a prior empty `SS', no vspace. */
+ if (n->prev && MAN_SS == n->prev->tok)
+ if (NULL == n->prev->body->child)
+ break;
+ if (NULL == n->prev)
+ break;
+ term_vspace(p);
break;
case (MAN_HEAD):
- p->flags |= TERMP_BOLD;
+ p->bold++;
p->offset = HALFINDENT;
break;
+ case (MAN_BODY):
+ p->offset = mt->offset;
+ break;
default:
- p->offset = INDENT;
break;
}
switch (n->type) {
case (MAN_HEAD):
term_newln(p);
- p->flags &= ~TERMP_BOLD;
+ p->bold--;
+ break;
+ case (MAN_BODY):
+ term_newln(p);
break;
default:
break;
static int
pre_SH(DECL_ARGS)
{
- /*
- * XXX: undocumented: using two `SH' macros in sequence has no
- * vspace between calls, only a newline.
- */
+
switch (n->type) {
case (MAN_BLOCK):
+ mt->lmargin = INDENT;
+ mt->offset = INDENT;
+ /* If following a prior empty `SH', no vspace. */
if (n->prev && MAN_SH == n->prev->tok)
if (NULL == n->prev->body->child)
break;
term_vspace(p);
break;
case (MAN_HEAD):
- p->flags |= TERMP_BOLD;
+ p->bold++;
p->offset = 0;
break;
case (MAN_BODY):
- p->offset = INDENT;
+ p->offset = mt->offset;
break;
default:
break;
switch (n->type) {
case (MAN_HEAD):
term_newln(p);
- p->flags &= ~TERMP_BOLD;
+ p->bold--;
break;
case (MAN_BODY):
term_newln(p);
}
+/* ARGSUSED */
+static int
+pre_RS(DECL_ARGS)
+{
+ const struct man_node *nn;
+ int ival;
+
+ switch (n->type) {
+ case (MAN_BLOCK):
+ term_newln(p);
+ return(1);
+ case (MAN_HEAD):
+ return(0);
+ default:
+ break;
+ }
+
+ if (NULL == (nn = n->parent->head->child)) {
+ mt->offset = mt->lmargin + INDENT;
+ p->offset = mt->offset;
+ return(1);
+ }
+
+ if ((ival = arg_width(nn)) < 0)
+ return(1);
+
+ mt->offset = INDENT + (size_t)ival;
+ p->offset = mt->offset;
+
+ return(1);
+}
+
+
+/* ARGSUSED */
+static void
+post_RS(DECL_ARGS)
+{
+
+ switch (n->type) {
+ case (MAN_BLOCK):
+ mt->offset = mt->lmargin = INDENT;
+ break;
+ default:
+ term_newln(p);
+ p->offset = INDENT;
+ break;
+ }
+}
+
+
static void
print_node(DECL_ARGS)
{
n->string[sz - 2] == '\\')
p->flags |= TERMP_NOSPACE;
/* FIXME: this means that macro lines are munged! */
- if (MANT_LITERAL & *fl) {
+ if (MANT_LITERAL & mt->fl) {
p->flags |= TERMP_NOSPACE;
term_flushln(p);
}
break;
default:
if (termacts[n->tok].pre)
- c = (*termacts[n->tok].pre)(p, fl, n, m);
+ c = (*termacts[n->tok].pre)(p, mt, n, m);
break;
}
if (c && n->child)
- print_body(p, fl, n->child, m);
+ print_body(p, mt, n->child, m);
if (MAN_TEXT != n->type)
if (termacts[n->tok].post)
- (*termacts[n->tok].post)(p, fl, n, m);
+ (*termacts[n->tok].post)(p, mt, n, m);
}
print_body(DECL_ARGS)
{
- print_node(p, fl, n, m);
+ print_node(p, mt, n, m);
if ( ! n->next)
return;
- print_body(p, fl, n->next, m);
+ print_body(p, mt, n->next, m);
}
char *buf;
if (NULL == (buf = malloc(p->rmargin)))
- err(1, "malloc");
+ err(EXIT_FAILURE, "malloc");
tm = localtime(&meta->date);
if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm))
- err(1, "strftime");
+ err(EXIT_FAILURE, "strftime");
term_vspace(p);
p->offset = 0;
if (NULL == (buf = malloc(p->rmargin)))
- err(1, "malloc");
+ err(EXIT_FAILURE, "malloc");
if (NULL == (title = malloc(p->rmargin)))
- err(1, "malloc");
+ err(EXIT_FAILURE, "malloc");
if (meta->vol)
(void)strlcpy(buf, meta->vol, p->rmargin);