]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_term.c
Fix in -Tascii where `Lb' causes line-break in any section (should only happen in...
[mandoc.git] / man_term.c
index 310ce5689e31e3e50c1fcfa9e17fbd501b00387e..b5b6891cf023ebb425272ec0e364b1c4d2308e0e 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: man_term.c,v 1.24 2009/08/18 08:48:30 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>
  *
@@ -14,6 +14,8 @@
  * 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>
 struct mtermp {
        int               fl;
 #define        MANT_LITERAL     (1 << 0)
-       int               lmargin;
+       /* 
+        * 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, \
@@ -54,11 +70,13 @@ static      int               pre_IR(DECL_ARGS);
 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);
@@ -67,6 +85,7 @@ 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);
@@ -94,12 +113,16 @@ static const struct termact termacts[MAN_MAX] = {
        { 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__
@@ -118,24 +141,21 @@ static    void              fmt_block_vspace(struct termp *,
 static int               arg_width(const struct man_node *);
 
 
-int
+void
 man_run(struct termp *p, const struct man *m)
 {
        struct mtermp    mt;
 
        print_head(p, man_meta(m));
        p->flags |= TERMP_NOSPACE;
-       assert(man_node(m));
-       assert(MAN_ROOT == man_node(m)->type);
 
        mt.fl = 0;
        mt.lmargin = INDENT;
+       mt.offset = INDENT;
 
        if (man_node(m)->child)
                print_body(p, &mt, man_node(m)->child, man_meta(m));
        print_foot(p, man_meta(m));
-
-       return(1);
 }
 
 
@@ -184,12 +204,21 @@ arg_width(const struct man_node *n)
 }
 
 
+/* ARGSUSED */
+static int
+pre_ign(DECL_ARGS)
+{
+
+       return(0);
+}
+
+
 /* ARGSUSED */
 static int
 pre_I(DECL_ARGS)
 {
 
-       p->flags |= TERMP_UNDER;
+       p->under++;
        return(1);
 }
 
@@ -199,8 +228,7 @@ static int
 pre_r(DECL_ARGS)
 {
 
-       p->flags &= ~TERMP_UNDER;
-       p->flags &= ~TERMP_BOLD;
+       p->bold = p->under = 0;
        return(1);
 }
 
@@ -211,7 +239,7 @@ post_i(DECL_ARGS)
 {
 
        if (n->nchild)
-               p->flags &= ~TERMP_UNDER;
+               p->under--;
 }
 
 
@@ -220,7 +248,7 @@ static void
 post_I(DECL_ARGS)
 {
 
-       p->flags &= ~TERMP_UNDER;
+       p->under--;
 }
 
 
@@ -254,12 +282,12 @@ pre_IR(DECL_ARGS)
 
        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, mt, nn, m);
                if ( ! (i % 2))
-                       p->flags &= ~TERMP_UNDER;
+                       p->under--;
        }
        return(0);
 }
@@ -273,11 +301,17 @@ pre_IB(DECL_ARGS)
        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, mt, nn, m);
-               p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER;
+               if (i % 2)
+                       p->bold--;
+               else
+                       p->under--;
        }
        return(0);
 }
@@ -292,12 +326,12 @@ pre_RB(DECL_ARGS)
 
        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, mt, nn, m);
                if (i % 2)
-                       p->flags &= ~TERMP_BOLD;
+                       p->bold--;
        }
        return(0);
 }
@@ -312,12 +346,12 @@ pre_RI(DECL_ARGS)
 
        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, mt, nn, m);
                if ( ! (i % 2))
-                       p->flags &= ~TERMP_UNDER;
+                       p->under--;
        }
        return(0);
 }
@@ -332,12 +366,12 @@ pre_BR(DECL_ARGS)
 
        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, mt, nn, m);
                if ( ! (i % 2))
-                       p->flags &= ~TERMP_BOLD;
+                       p->bold--;
        }
        return(0);
 }
@@ -351,11 +385,17 @@ pre_BI(DECL_ARGS)
        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, mt, nn, m);
-               p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD;
+               if (i % 2)
+                       p->under--;
+               else
+                       p->bold--;
        }
        return(0);
 }
@@ -366,7 +406,7 @@ static int
 pre_B(DECL_ARGS)
 {
 
-       p->flags |= TERMP_BOLD;
+       p->bold++;
        return(1);
 }
 
@@ -376,7 +416,7 @@ static void
 post_B(DECL_ARGS)
 {
 
-       p->flags &= ~TERMP_BOLD;
+       p->bold--;
 }
 
 
@@ -431,7 +471,7 @@ pre_HP(DECL_ARGS)
                return(0);
        }
 
-       len = (size_t)mt->lmargin;
+       len = mt->lmargin;
        ival = -1;
 
        /* Calculate offset. */
@@ -443,11 +483,11 @@ pre_HP(DECL_ARGS)
        if (0 == len)
                len = 1;
 
-       p->offset = INDENT;
-       p->rmargin = INDENT + len;
+       p->offset = mt->offset;
+       p->rmargin = mt->offset + len;
 
        if (ival >= 0)
-               mt->lmargin = ival;
+               mt->lmargin = (size_t)ival;
 
        return(1);
 }
@@ -466,7 +506,7 @@ post_HP(DECL_ARGS)
                term_flushln(p);
                p->flags &= ~TERMP_NOBREAK;
                p->flags &= ~TERMP_TWOSPACE;
-               p->offset = INDENT;
+               p->offset = mt->offset;
                p->rmargin = p->maxrmargin;
                break;
        default:
@@ -486,7 +526,7 @@ pre_PP(DECL_ARGS)
                fmt_block_vspace(p, n);
                break;
        default:
-               p->offset = INDENT;
+               p->offset = mt->offset;
                break;
        }
 
@@ -518,7 +558,7 @@ pre_IP(DECL_ARGS)
                return(1);
        }
 
-       len = (size_t)mt->lmargin;
+       len = mt->lmargin;
        ival = -1;
 
        /* Calculate offset. */
@@ -537,20 +577,20 @@ pre_IP(DECL_ARGS)
                if (0 == len)
                        len = 1;
 
-               p->offset = INDENT;
-               p->rmargin = INDENT + len;
+               p->offset = mt->offset;
+               p->rmargin = mt->offset + len;
                if (ival < 0)
                        break;
 
                /* Set the saved left-margin. */
-               mt->lmargin = ival;
+               mt->lmargin = (size_t)ival;
 
                /* 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 = INDENT + len;
+               p->offset = mt->offset + len;
                p->rmargin = p->maxrmargin;
                break;
        default:
@@ -623,8 +663,8 @@ pre_TP(DECL_ARGS)
                if (0 == len)
                        len = 1;
 
-               p->offset = INDENT;
-               p->rmargin = INDENT + len;
+               p->offset = mt->offset;
+               p->rmargin = mt->offset + len;
 
                /* Don't print same-line elements. */
                for (nn = n->child; nn; nn = nn->next) 
@@ -632,11 +672,11 @@ pre_TP(DECL_ARGS)
                                print_node(p, mt, nn, m);
 
                if (ival >= 0)
-                       mt->lmargin = ival;
+                       mt->lmargin = (size_t)ival;
 
                return(0);
        case (MAN_BODY):
-               p->offset = INDENT + len;
+               p->offset = mt->offset + len;
                p->rmargin = p->maxrmargin;
                break;
        default:
@@ -677,6 +717,7 @@ pre_SS(DECL_ARGS)
        switch (n->type) {
        case (MAN_BLOCK):
                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)
@@ -686,11 +727,11 @@ pre_SS(DECL_ARGS)
                term_vspace(p);
                break;
        case (MAN_HEAD):
-               p->flags |= TERMP_BOLD;
+               p->bold++;
                p->offset = HALFINDENT;
                break;
        case (MAN_BODY):
-               p->offset = INDENT;
+               p->offset = mt->offset;
                break;
        default:
                break;
@@ -708,7 +749,7 @@ post_SS(DECL_ARGS)
        switch (n->type) {
        case (MAN_HEAD):
                term_newln(p);
-               p->flags &= ~TERMP_BOLD;
+               p->bold--;
                break;
        case (MAN_BODY):
                term_newln(p);
@@ -727,6 +768,7 @@ pre_SH(DECL_ARGS)
        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)
@@ -734,11 +776,11 @@ pre_SH(DECL_ARGS)
                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;
@@ -756,7 +798,7 @@ post_SH(DECL_ARGS)
        switch (n->type) {
        case (MAN_HEAD):
                term_newln(p);
-               p->flags &= ~TERMP_BOLD;
+               p->bold--;
                break;
        case (MAN_BODY):
                term_newln(p);
@@ -767,6 +809,56 @@ post_SH(DECL_ARGS)
 }
 
 
+/* 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)
 {
@@ -830,12 +922,12 @@ print_foot(struct termp *p, const struct man_meta *meta)
        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);
 
@@ -870,9 +962,9 @@ print_head(struct termp *p, const struct man_meta *meta)
        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);