]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_term.c
Documented `Fl' in mdoc.7.
[mandoc.git] / mdoc_term.c
index bda0a669c1edcc4652bd8f8fa365208d3ecb1dc5..bc22243646d1312113278290e2d115c985e7bed9 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.95 2009/10/24 05:52:14 kristaps Exp $ */
+/*     $Id: mdoc_term.c,v 1.104 2010/01/01 13:35:30 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -18,7 +18,6 @@
 
 #include <assert.h>
 #include <ctype.h>
-#include <err.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -48,6 +47,28 @@ struct       termact {
        void    (*post)(DECL_ARGS);
 };
 
+static size_t    a2width(const struct mdoc_argv *, int);
+static size_t    a2height(const struct mdoc_node *);
+static size_t    a2offs(const struct mdoc_argv *);
+
+static int       arg_hasattr(int, const struct mdoc_node *);
+static int       arg_getattrs(const int *, int *, size_t,
+                       const struct mdoc_node *);
+static int       arg_getattr(int, const struct mdoc_node *);
+static int       arg_listtype(const struct mdoc_node *);
+static void      print_bvspace(struct termp *,
+                       const struct mdoc_node *,
+                       const struct mdoc_node *);
+static void      print_mdoc_node(DECL_ARGS);
+static void      print_mdoc_head(DECL_ARGS);
+static void      print_mdoc_nodelist(DECL_ARGS);
+static void      print_foot(DECL_ARGS);
+
+#ifdef __linux__
+extern size_t    strlcpy(char *, const char *, size_t);
+extern size_t    strlcat(char *, const char *, size_t);
+#endif
+
 static void      termp____post(DECL_ARGS);
 static void      termp_an_post(DECL_ARGS);
 static void      termp_aq_post(DECL_ARGS);
@@ -95,6 +116,7 @@ static       int       termp_fo_pre(DECL_ARGS);
 static int       termp_ft_pre(DECL_ARGS);
 static int       termp_in_pre(DECL_ARGS);
 static int       termp_it_pre(DECL_ARGS);
+static int       termp_li_pre(DECL_ARGS);
 static int       termp_lk_pre(DECL_ARGS);
 static int       termp_nd_pre(DECL_ARGS);
 static int       termp_nm_pre(DECL_ARGS);
@@ -146,7 +168,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { termp_ft_pre, termp_ft_post }, /* Ft */ 
        { termp_bold_pre, NULL }, /* Ic */ 
        { termp_in_pre, termp_in_post }, /* In */ 
-       { NULL, NULL }, /* Li */
+       { termp_li_pre, NULL }, /* Li */
        { termp_nd_pre, NULL }, /* Nd */ 
        { termp_nm_pre, NULL }, /* Nm */ 
        { termp_op_pre, termp_op_post }, /* Op */
@@ -236,31 +258,9 @@ static     const struct termact termacts[MDOC_MAX] = {
        { NULL, termp____post }, /* %Q */ 
        { termp_sp_pre, NULL }, /* br */
        { termp_sp_pre, NULL }, /* sp */ 
-       { NULL, termp____post }, /* %U */ 
+       { termp_under_pre, termp____post }, /* %U */ 
 };
 
-#ifdef __linux__
-extern size_t    strlcpy(char *, const char *, size_t);
-extern size_t    strlcat(char *, const char *, size_t);
-#endif
-
-static size_t    arg2width(const struct mdoc_argv *, int);
-static size_t    arg2height(const struct mdoc_node *);
-static size_t    arg2offs(const struct mdoc_argv *);
-
-static int       arg_hasattr(int, const struct mdoc_node *);
-static int       arg_getattrs(const int *, int *, size_t,
-                       const struct mdoc_node *);
-static int       arg_getattr(int, const struct mdoc_node *);
-static int       arg_listtype(const struct mdoc_node *);
-static void      print_bvspace(struct termp *,
-                       const struct mdoc_node *,
-                       const struct mdoc_node *);
-static void      print_node(DECL_ARGS);
-static void      print_head(DECL_ARGS);
-static void      print_body(DECL_ARGS);
-static void      print_foot(DECL_ARGS);
-
 
 void
 terminal_mdoc(void *arg, const struct mdoc *mdoc)
@@ -284,38 +284,38 @@ terminal_mdoc(void *arg, const struct mdoc *mdoc)
        n = mdoc_node(mdoc);
        m = mdoc_meta(mdoc);
 
-       print_head(p, NULL, m, n);
+       print_mdoc_head(p, NULL, m, n);
        if (n->child)
-               print_body(p, NULL, m, n->child);
+               print_mdoc_nodelist(p, NULL, m, n->child);
        print_foot(p, NULL, m, n);
 }
 
 
 static void
-print_body(DECL_ARGS)
+print_mdoc_nodelist(DECL_ARGS)
 {
 
-       print_node(p, pair, m, n);
+       print_mdoc_node(p, pair, m, n);
        if (n->next)
-               print_body(p, pair, m, n->next);
+               print_mdoc_nodelist(p, pair, m, n->next);
 }
 
 
 /* ARGSUSED */
 static void
-print_node(DECL_ARGS)
+print_mdoc_node(DECL_ARGS)
 {
-       int              chld, bold, under;
+       int              chld;
+       const void      *font;
        struct termpair  npair;
        size_t           offset, rmargin;
 
        chld = 1;
        offset = p->offset;
        rmargin = p->rmargin;
-       bold = p->bold;
-       under = p->under;
+       font = term_fontq(p);
 
-       bzero(&npair, sizeof(struct termpair));
+       memset(&npair, 0, sizeof(struct termpair));
        npair.ppair = pair;
 
        if (MDOC_TEXT != n->type) {
@@ -323,17 +323,11 @@ print_node(DECL_ARGS)
                        chld = (*termacts[n->tok].pre)(p, &npair, m, n);
        } else 
                term_word(p, n->string); 
-       if (chld && n->child)
-               print_body(p, &npair, m, n->child);
 
-       /*
-        * XXX - if bold/under were to span scopes, this wouldn't be
-        * possible, but because decoration is always in-scope, we can
-        * get away with this.
-        */
+       if (chld && n->child)
+               print_mdoc_nodelist(p, &npair, m, n->child);
 
-       p->bold = bold;
-       p->under = under;
+       term_fontpopq(p, font);
 
        if (MDOC_TEXT != n->type)
                if (termacts[n->tok].post)
@@ -348,8 +342,9 @@ print_node(DECL_ARGS)
 static void
 print_foot(DECL_ARGS)
 {
-       char             buf[DATESIZ];
-       char            *os;
+       char            buf[DATESIZ], os[BUFSIZ];
+
+       term_fontrepl(p, TERMFONT_NONE);
 
        /* 
         * Output the footer in new-groff style, that is, three columns
@@ -359,12 +354,8 @@ print_foot(DECL_ARGS)
         * SYSTEM                  DATE                    SYSTEM
         */
 
-       if (NULL == (os = malloc(p->rmargin)))
-               err(EXIT_FAILURE, "malloc");
-
        time2a(m->date, buf, DATESIZ);
-
-       (void)strlcpy(os, m->os, p->rmargin);
+       strlcpy(os, m->os, BUFSIZ);
 
        term_vspace(p);
 
@@ -393,26 +384,18 @@ print_foot(DECL_ARGS)
        p->offset = 0;
        p->rmargin = p->maxrmargin;
        p->flags = 0;
-
-       free(os);
 }
 
 
-/* FIXME: put in utility library. */
 /* ARGSUSED */
 static void
-print_head(DECL_ARGS)
+print_mdoc_head(DECL_ARGS)
 {
-       char            *buf, *title;
+       char            buf[BUFSIZ], title[BUFSIZ];
 
        p->rmargin = p->maxrmargin;
        p->offset = 0;
 
-       if (NULL == (buf = malloc(p->rmargin)))
-               err(EXIT_FAILURE, "malloc");
-       if (NULL == (title = malloc(p->rmargin)))
-               err(EXIT_FAILURE, "malloc");
-
        /*
         * The header is strange.  It has three components, which are
         * really two with the first duplicated.  It goes like this:
@@ -427,15 +410,15 @@ print_head(DECL_ARGS)
         */
 
        assert(m->vol);
-       (void)strlcpy(buf, m->vol, p->rmargin);
+       strlcpy(buf, m->vol, BUFSIZ);
 
        if (m->arch) {
-               (void)strlcat(buf, " (", p->rmargin);
-               (void)strlcat(buf, m->arch, p->rmargin);
-               (void)strlcat(buf, ")", p->rmargin);
+               strlcat(buf, " (", BUFSIZ);
+               strlcat(buf, m->arch, BUFSIZ);
+               strlcat(buf, ")", BUFSIZ);
        }
 
-       snprintf(title, p->rmargin, "%s(%d)", m->title, m->msec);
+       snprintf(title, BUFSIZ, "%s(%d)", m->title, m->msec);
 
        p->offset = 0;
        p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;
@@ -462,14 +445,11 @@ print_head(DECL_ARGS)
        p->offset = 0;
        p->rmargin = p->maxrmargin;
        p->flags &= ~TERMP_NOSPACE;
-
-       free(title);
-       free(buf);
 }
 
 
 static size_t
-arg2height(const struct mdoc_node *n)
+a2height(const struct mdoc_node *n)
 {
        struct roffsu    su;
 
@@ -483,7 +463,7 @@ arg2height(const struct mdoc_node *n)
 
 
 static size_t
-arg2width(const struct mdoc_argv *arg, int pos)
+a2width(const struct mdoc_argv *arg, int pos)
 {
        struct roffsu    su;
 
@@ -538,7 +518,7 @@ arg_listtype(const struct mdoc_node *n)
 
 
 static size_t
-arg2offs(const struct mdoc_argv *arg)
+a2offs(const struct mdoc_argv *arg)
 {
        struct roffsu    su;
 
@@ -717,23 +697,23 @@ termp_it_pre(DECL_ARGS)
                for (i = 0, nn = n->prev; nn && 
                                i < (int)bl->args->argv[vals[2]].sz; 
                                nn = nn->prev, i++)
-                       offset += arg2width 
+                       offset += a2width 
                                (&bl->args->argv[vals[2]], i);
 
                /* Whether exceeds maximum column. */
                if (i < (int)bl->args->argv[vals[2]].sz)
-                       width = arg2width(&bl->args->argv[vals[2]], i);
+                       width = a2width(&bl->args->argv[vals[2]], i);
                else
                        width = 0;
 
                if (vals[1] >= 0) 
-                       offset += arg2offs(&bl->args->argv[vals[1]]);
+                       offset += a2offs(&bl->args->argv[vals[1]]);
                break;
        default:
                if (vals[0] >= 0) 
-                       width = arg2width(&bl->args->argv[vals[0]], 0);
+                       width = a2width(&bl->args->argv[vals[0]], 0);
                if (vals[1] >= 0) 
-                       offset += arg2offs(&bl->args->argv[vals[1]]);
+                       offset += a2offs(&bl->args->argv[vals[1]]);
                break;
        }
 
@@ -795,7 +775,7 @@ termp_it_pre(DECL_ARGS)
        switch (type) {
        case (MDOC_Diag):
                if (MDOC_HEAD == n->type)
-                       p->bold++;
+                       term_fontpush(p, TERMFONT_BOLD);
                break;
        default:
                break;
@@ -933,16 +913,16 @@ termp_it_pre(DECL_ARGS)
        if (MDOC_HEAD == n->type)
                switch (type) {
                case (MDOC_Bullet):
-                       p->bold++;
+                       term_fontpush(p, TERMFONT_BOLD);
                        term_word(p, "\\[bu]");
-                       p->bold--;
+                       term_fontpop(p);
                        break;
                case (MDOC_Dash):
                        /* FALLTHROUGH */
                case (MDOC_Hyphen):
-                       p->bold++;
+                       term_fontpush(p, TERMFONT_BOLD);
                        term_word(p, "\\(hy");
-                       p->bold--;
+                       term_fontpop(p);
                        break;
                case (MDOC_Enum):
                        (pair->ppair->ppair->count)++;
@@ -1024,7 +1004,9 @@ termp_nm_pre(DECL_ARGS)
 
        if (SEC_SYNOPSIS == n->sec)
                term_newln(p);
-       p->bold++;
+
+       term_fontpush(p, TERMFONT_BOLD);
+
        if (NULL == n->child)
                term_word(p, m->name);
        return(1);
@@ -1036,9 +1018,14 @@ static int
 termp_fl_pre(DECL_ARGS)
 {
 
-       p->bold++;
+       term_fontpush(p, TERMFONT_BOLD);
        term_word(p, "\\-");
-       p->flags |= TERMP_NOSPACE;
+
+       /* A blank `Fl' should incur a subsequent space. */
+
+       if (n->child)
+               p->flags |= TERMP_NOSPACE;
+
        return(1);
 }
 
@@ -1134,9 +1121,9 @@ termp_rv_pre(DECL_ARGS)
        term_word(p, "The");
 
        for (nn = n->child; nn; nn = nn->next) {
-               p->bold++;
+               term_fontpush(p, TERMFONT_BOLD);
                term_word(p, nn->string);
-               p->bold--;
+               term_fontpop(p);
                p->flags |= TERMP_NOSPACE;
                if (nn->next && NULL == nn->next->next)
                        term_word(p, "(), and");
@@ -1154,9 +1141,9 @@ termp_rv_pre(DECL_ARGS)
                term_word(p, "the value 0 if successful; otherwise the value "
                        "-1 is returned and the global variable");
 
-       p->under++;
+       term_fontpush(p, TERMFONT_UNDER);
        term_word(p, "errno");
-       p->under--;
+       term_fontpop(p);
 
                term_word(p, "is set to indicate the error.");
 
@@ -1173,9 +1160,9 @@ termp_ex_pre(DECL_ARGS)
        term_word(p, "The");
 
        for (nn = n->child; nn; nn = nn->next) {
-               p->bold++;
+               term_fontpush(p, TERMFONT_BOLD);
                term_word(p, nn->string);
-               p->bold--;
+               term_fontpop(p);
                p->flags |= TERMP_NOSPACE;
                if (nn->next && NULL == nn->next->next)
                        term_word(p, ", and");
@@ -1277,7 +1264,7 @@ static int
 termp_bold_pre(DECL_ARGS)
 {
 
-       p->bold++;
+       term_fontpush(p, TERMFONT_BOLD);
        return(1);
 }
 
@@ -1311,7 +1298,7 @@ termp_sh_pre(DECL_ARGS)
                term_vspace(p);
                break;
        case (MDOC_HEAD):
-               p->bold++;
+               term_fontpush(p, TERMFONT_BOLD);
                break;
        case (MDOC_BODY):
                p->offset = INDENT;
@@ -1446,7 +1433,8 @@ termp_ft_pre(DECL_ARGS)
        if (SEC_SYNOPSIS == n->sec)
                if (n->prev && MDOC_Fo == n->prev->tok)
                        term_vspace(p);
-       p->under++;
+
+       term_fontpush(p, TERMFONT_UNDER);
        return(1);
 }
 
@@ -1467,17 +1455,18 @@ termp_fn_pre(DECL_ARGS)
 {
        const struct mdoc_node  *nn;
 
-       p->bold++;
+       term_fontpush(p, TERMFONT_BOLD);
        term_word(p, n->child->string);
-       p->bold--;
+       term_fontpop(p);
 
        p->flags |= TERMP_NOSPACE;
        term_word(p, "(");
 
        for (nn = n->child->next; nn; nn = nn->next) {
-               p->under++;
+               term_fontpush(p, TERMFONT_UNDER);
                term_word(p, nn->string);
-               p->under--;
+               term_fontpop(p);
+
                if (nn->next)
                        term_word(p, ",");
        }
@@ -1508,14 +1497,15 @@ termp_fa_pre(DECL_ARGS)
        const struct mdoc_node  *nn;
 
        if (n->parent->tok != MDOC_Fo) {
-               p->under++;
+               term_fontpush(p, TERMFONT_UNDER);
                return(1);
        }
 
        for (nn = n->child; nn; nn = nn->next) {
-               p->under++;
+               term_fontpush(p, TERMFONT_UNDER);
                term_word(p, nn->string);
-               p->under--;
+               term_fontpop(p);
+
                if (nn->next)
                        term_word(p, ",");
        }
@@ -1556,7 +1546,7 @@ termp_bd_pre(DECL_ARGS)
                        type = nn->args->argv[i].arg;
                        break;
                case (MDOC_Offset):
-                       p->offset += arg2offs(&nn->args->argv[i]);
+                       p->offset += a2offs(&nn->args->argv[i]);
                        break;
                default:
                        break;
@@ -1577,7 +1567,7 @@ termp_bd_pre(DECL_ARGS)
 
        for (nn = n->child; nn; nn = nn->next) {
                p->flags |= TERMP_NOSPACE;
-               print_node(p, pair, m, nn);
+               print_mdoc_node(p, pair, m, nn);
                if (NULL == nn->next)
                        continue;
                if (nn->prev && nn->prev->line < nn->line)
@@ -1650,7 +1640,7 @@ termp_xx_pre(DECL_ARGS)
                pp = "BSDI BSD/OS";
                break;
        case (MDOC_Dx):
-               pp = "DragonFlyBSD";
+               pp = "DragonFly";
                break;
        case (MDOC_Fx):
                pp = "FreeBSD";
@@ -1731,7 +1721,7 @@ termp_ss_pre(DECL_ARGS)
                        term_vspace(p);
                break;
        case (MDOC_HEAD):
-               p->bold++;
+               term_fontpush(p, TERMFONT_BOLD);
                p->offset = HALFINDENT;
                break;
        default:
@@ -1757,7 +1747,7 @@ static int
 termp_cd_pre(DECL_ARGS)
 {
 
-       p->bold++;
+       term_fontpush(p, TERMFONT_BOLD);
        term_newln(p);
        return(1);
 }
@@ -1768,7 +1758,7 @@ static int
 termp_in_pre(DECL_ARGS)
 {
 
-       p->bold++;
+       term_fontpush(p, TERMFONT_BOLD);
        if (SEC_SYNOPSIS == n->sec)
                term_word(p, "#include");
 
@@ -1783,10 +1773,10 @@ static void
 termp_in_post(DECL_ARGS)
 {
 
-       p->bold++;
+       term_fontpush(p, TERMFONT_BOLD);
        p->flags |= TERMP_NOSPACE;
        term_word(p, ">");
-       p->bold--;
+       term_fontpop(p);
 
        if (SEC_SYNOPSIS != n->sec)
                return;
@@ -1811,7 +1801,7 @@ termp_sp_pre(DECL_ARGS)
 
        switch (n->tok) {
        case (MDOC_sp):
-               len = n->child ? arg2height(n->child) : 1;
+               len = n->child ? a2height(n->child) : 1;
                break;
        case (MDOC_br):
                len = 0;
@@ -1918,12 +1908,12 @@ termp_fo_pre(DECL_ARGS)
        } else if (MDOC_HEAD != n->type) 
                return(1);
 
-       p->bold++;
+       term_fontpush(p, TERMFONT_BOLD);
        for (nn = n->child; nn; nn = nn->next) {
                assert(MDOC_TEXT == nn->type);
                term_word(p, nn->string);
        }
-       p->bold--;
+       term_fontpop(p);
 
        return(0);
 }
@@ -1957,18 +1947,22 @@ termp_bf_pre(DECL_ARGS)
 
        if (NULL == (nn = n->head->child)) {
                if (arg_hasattr(MDOC_Emphasis, n))
-                       p->under++;
+                       term_fontpush(p, TERMFONT_UNDER);
                else if (arg_hasattr(MDOC_Symbolic, n))
-                       p->bold++;
+                       term_fontpush(p, TERMFONT_BOLD);
+               else
+                       term_fontpush(p, TERMFONT_NONE);
 
                return(1);
        } 
 
        assert(MDOC_TEXT == nn->type);
        if (0 == strcmp("Em", nn->string))
-               p->under++;
+               term_fontpush(p, TERMFONT_UNDER);
        else if (0 == strcmp("Sy", nn->string))
-               p->bold++;
+               term_fontpush(p, TERMFONT_BOLD);
+       else
+               term_fontpush(p, TERMFONT_NONE);
 
        return(1);
 }
@@ -2022,27 +2016,38 @@ termp____post(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
+static int
+termp_li_pre(DECL_ARGS)
+{
+
+       term_fontpush(p, TERMFONT_NONE);
+       return(1);
+}
+
+
 /* ARGSUSED */
 static int
 termp_lk_pre(DECL_ARGS)
 {
        const struct mdoc_node *nn;
 
-       if (NULL == (nn = n->child->next)) {
-               p->under++;
+       term_fontpush(p, TERMFONT_UNDER);
+       nn = n->child;
+
+       if (NULL == nn->next)
                return(1);
-       }
 
-       p->under++;
        term_word(p, nn->string);
+       term_fontpop(p);
+
        p->flags |= TERMP_NOSPACE;
        term_word(p, ":");
-       p->under--;
 
-       p->bold++;
+       term_fontpush(p, TERMFONT_BOLD);
        for (nn = nn->next; nn; nn = nn->next) 
                term_word(p, nn->string);
-       p->bold--;
+       term_fontpop(p);
 
        return(0);
 }
@@ -2053,7 +2058,7 @@ static int
 termp_under_pre(DECL_ARGS)
 {
 
-       p->under++;
+       term_fontpush(p, TERMFONT_UNDER);
        return(1);
 }