Added proper `TP' support.

[mandoc.git] / man_term.c

diff --git a/man_term.c b/man_term.c
index b07602d3f1226c2e90017ce591c6a3c3ec9e215b..6506d08e9cd4baed768f54336d1519941e24171a 100644 (file)
--- a/man_term.c
+++ b/man_term.c
@@ -1,4 +1,4 @@
-/*     $Id: man_term.c,v 1.13 2009/06/15 20:26:47 kristaps Exp $ */
+/*     $Id: man_term.c,v 1.21 2009/08/13 12:31:50 kristaps Exp $ */

 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -15,6 +15,7 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 #include <assert.h>
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 #include <assert.h>

+#include <ctype.h>

 #include <err.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <err.h>
 #include <stdio.h>
 #include <stdlib.h>


@@ -23,12 +24,18 @@
 #include "term.h"
 #include "man.h"
 
 #include "term.h"
 #include "man.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
 
 #ifdef __linux__
 extern size_t            strlcpy(char *, const char *, size_t);
 extern size_t            strlcat(char *, const char *, size_t);
 #endif
 

+#define        MANT_LITERAL     (1 << 0)
+

 #define        DECL_ARGS         struct termp *p, \
 #define        DECL_ARGS         struct termp *p, \

+                         int *fl, \

                          const struct man_node *n, \
                          const struct man_meta *m
 
                          const struct man_node *n, \
                          const struct man_meta *m
 


@@ -40,6 +47,7 @@ struct        termact {
 static int               pre_B(DECL_ARGS);
 static int               pre_BI(DECL_ARGS);
 static int               pre_BR(DECL_ARGS);
 static int               pre_B(DECL_ARGS);
 static int               pre_BI(DECL_ARGS);
 static int               pre_BR(DECL_ARGS);

+static int               pre_HP(DECL_ARGS);

 static int               pre_I(DECL_ARGS);
 static int               pre_IB(DECL_ARGS);
 static int               pre_IP(DECL_ARGS);
 static int               pre_I(DECL_ARGS);
 static int               pre_IB(DECL_ARGS);
 static int               pre_IP(DECL_ARGS);


@@ -50,23 +58,31 @@ static      int               pre_RI(DECL_ARGS);
 static int               pre_SH(DECL_ARGS);
 static int               pre_SS(DECL_ARGS);
 static int               pre_TP(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_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_B(DECL_ARGS);
 static void              post_I(DECL_ARGS);

+static void              post_HP(DECL_ARGS);

 static void              post_SH(DECL_ARGS);
 static void              post_SS(DECL_ARGS);
 static void              post_SH(DECL_ARGS);
 static void              post_SS(DECL_ARGS);

+static void              post_TP(DECL_ARGS);
+static void              post_i(DECL_ARGS);

 
 static const struct termact termacts[MAN_MAX] = {
 
 static const struct termact termacts[MAN_MAX] = {

-       { NULL, NULL }, /* __ */
+       { pre_br, NULL }, /* br */

        { NULL, NULL }, /* TH */
        { pre_SH, post_SH }, /* SH */
        { pre_SS, post_SS }, /* SS */
        { NULL, NULL }, /* TH */
        { pre_SH, post_SH }, /* SH */
        { pre_SS, post_SS }, /* SS */

-       { pre_TP, NULL }, /* TP */
+       { pre_TP, post_TP }, /* TP */

        { pre_PP, NULL }, /* LP */
        { pre_PP, NULL }, /* PP */
        { pre_PP, NULL }, /* P */
        { pre_IP, NULL }, /* IP */
        { pre_PP, NULL }, /* LP */
        { pre_PP, NULL }, /* PP */
        { pre_PP, NULL }, /* P */
        { pre_IP, NULL }, /* IP */

-       { pre_PP, NULL }, /* HP */ /* FIXME */
+       { pre_HP, post_HP }, /* HP */ 

        { NULL, NULL }, /* SM */
        { pre_B, post_B }, /* SB */
        { pre_BI, NULL }, /* BI */
        { NULL, NULL }, /* SM */
        { pre_B, post_B }, /* SB */
        { pre_BI, NULL }, /* BI */


@@ -78,9 +94,12 @@ static const struct termact termacts[MAN_MAX] = {
        { pre_I, post_I }, /* I */
        { pre_IR, NULL }, /* IR */
        { pre_RI, NULL }, /* RI */
        { pre_I, post_I }, /* I */
        { pre_IR, NULL }, /* IR */
        { pre_RI, NULL }, /* RI */

-       { pre_PP, NULL }, /* br */
-       { NULL, NULL }, /* na */
-       { pre_I, post_I }, /* i */
+       { NULL, NULL }, /* na */ /* TODO: document that has no effect */
+       { pre_I, post_i }, /* i */
+       { pre_sp, NULL }, /* sp */
+       { pre_nf, NULL }, /* nf */
+       { pre_fi, NULL }, /* fi */
+       { pre_r, NULL }, /* r */

 };
 
 static void              print_head(struct termp *, 
 };
 
 static void              print_head(struct termp *, 


@@ -89,21 +108,75 @@ static     void              print_body(DECL_ARGS);
 static void              print_node(DECL_ARGS);
 static void              print_foot(struct termp *, 
                                const struct man_meta *);
 static void              print_node(DECL_ARGS);
 static void              print_foot(struct termp *, 
                                const struct man_meta *);

+static void              fmt_block_vspace(struct termp *, 
+                               const struct man_node *);
+static int               arg_width(const struct man_node *);

 
 
 int
 man_run(struct termp *p, const struct man *m)
 {
 
 
 int
 man_run(struct termp *p, const struct man *m)
 {

+       int              fl;

 
        print_head(p, man_meta(m));
        p->flags |= TERMP_NOSPACE;
 
        print_head(p, man_meta(m));
        p->flags |= TERMP_NOSPACE;

-       print_body(p, man_node(m), man_meta(m));
+       assert(man_node(m));
+       assert(MAN_ROOT == man_node(m)->type);
+
+       fl = 0;
+       if (man_node(m)->child)
+               print_body(p, &fl, man_node(m)->child, man_meta(m));

        print_foot(p, man_meta(m));
 
        return(1);
 }
 
 
        print_foot(p, man_meta(m));
 
        return(1);
 }
 
 

+static void
+fmt_block_vspace(struct termp *p, const struct man_node *n)
+{
+       term_newln(p);
+
+       if (NULL == n->prev)
+               return;
+
+       if (MAN_SS == n->prev->tok)
+               return;
+       if (MAN_SH == n->prev->tok)
+               return;
+
+       term_vspace(p);
+}
+
+
+static int
+arg_width(const struct man_node *n)
+{
+       int              i, len;
+       const char      *p;
+
+       assert(MAN_TEXT == n->type);
+       assert(n->string);
+
+       p = n->string;
+
+       if (0 == (len = (int)strlen(p)))
+               return(-1);
+
+       for (i = 0; i < len; i++) 
+               if ( ! isdigit((u_char)p[i]))
+                       break;
+
+       if (i == len - 1)  {
+               if ('n' == p[len - 1] || 'm' == p[len - 1])
+                       return(atoi(p));
+       } else if (i == len)
+               return(atoi(p));
+
+       return(-1);
+}
+
+

 /* ARGSUSED */
 static int
 pre_I(DECL_ARGS)
 /* ARGSUSED */
 static int
 pre_I(DECL_ARGS)


@@ -114,6 +187,27 @@ pre_I(DECL_ARGS)
 }
 
 
 }
 
 

+/* ARGSUSED */
+static int
+pre_r(DECL_ARGS)
+{
+
+       p->flags &= ~TERMP_UNDER;
+       p->flags &= ~TERMP_BOLD;
+       return(1);
+}
+
+
+/* ARGSUSED */
+static void
+post_i(DECL_ARGS)
+{
+
+       if (n->nchild)
+               p->flags &= ~TERMP_UNDER;
+}
+
+

 /* ARGSUSED */
 static void
 post_I(DECL_ARGS)
 /* ARGSUSED */
 static void
 post_I(DECL_ARGS)


@@ -123,6 +217,27 @@ post_I(DECL_ARGS)
 }
 
 
 }
 
 

+/* ARGSUSED */
+static int
+pre_fi(DECL_ARGS)
+{
+
+       *fl &= ~MANT_LITERAL;
+       return(1);
+}
+
+
+/* ARGSUSED */
+static int
+pre_nf(DECL_ARGS)
+{
+
+       term_newln(p);
+       *fl |= MANT_LITERAL;
+       return(1);
+}
+
+

 /* ARGSUSED */
 static int
 pre_IR(DECL_ARGS)
 /* ARGSUSED */
 static int
 pre_IR(DECL_ARGS)


@@ -135,7 +250,7 @@ pre_IR(DECL_ARGS)
                        p->flags |= TERMP_UNDER;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;
                        p->flags |= TERMP_UNDER;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;

-               print_node(p, nn, m);
+               print_node(p, fl, nn, m);

                if ( ! (i % 2))
                        p->flags &= ~TERMP_UNDER;
        }
                if ( ! (i % 2))
                        p->flags &= ~TERMP_UNDER;
        }


@@ -154,7 +269,7 @@ pre_IB(DECL_ARGS)
                p->flags |= i % 2 ? TERMP_BOLD : TERMP_UNDER;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;
                p->flags |= i % 2 ? TERMP_BOLD : TERMP_UNDER;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;

-               print_node(p, nn, m);
+               print_node(p, fl, nn, m);

                p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER;
        }
        return(0);
                p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER;
        }
        return(0);


@@ -173,7 +288,7 @@ pre_RB(DECL_ARGS)
                        p->flags |= TERMP_BOLD;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;
                        p->flags |= TERMP_BOLD;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;

-               print_node(p, nn, m);
+               print_node(p, fl, nn, m);

                if (i % 2)
                        p->flags &= ~TERMP_BOLD;
        }
                if (i % 2)
                        p->flags &= ~TERMP_BOLD;
        }


@@ -193,7 +308,7 @@ pre_RI(DECL_ARGS)
                        p->flags |= TERMP_UNDER;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;
                        p->flags |= TERMP_UNDER;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;

-               print_node(p, nn, m);
+               print_node(p, fl, nn, m);

                if ( ! (i % 2))
                        p->flags &= ~TERMP_UNDER;
        }
                if ( ! (i % 2))
                        p->flags &= ~TERMP_UNDER;
        }


@@ -213,7 +328,7 @@ pre_BR(DECL_ARGS)
                        p->flags |= TERMP_BOLD;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;
                        p->flags |= TERMP_BOLD;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;

-               print_node(p, nn, m);
+               print_node(p, fl, nn, m);

                if ( ! (i % 2))
                        p->flags &= ~TERMP_BOLD;
        }
                if ( ! (i % 2))
                        p->flags &= ~TERMP_BOLD;
        }


@@ -232,7 +347,7 @@ pre_BI(DECL_ARGS)
                p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;
                p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD;
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;

-               print_node(p, nn, m);
+               print_node(p, fl, nn, m);

                p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD;
        }
        return(0);
                p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD;
        }
        return(0);


@@ -260,47 +375,147 @@ post_B(DECL_ARGS)
 
 /* ARGSUSED */
 static int
 
 /* ARGSUSED */
 static int

-pre_PP(DECL_ARGS)
+pre_sp(DECL_ARGS)

 {
 {

+       int              i, len;
+
+       if (NULL == n->child) {
+               term_vspace(p);
+               return(0);
+       }
+
+       len = atoi(n->child->string);
+       if (0 == len)
+               term_newln(p);
+       for (i = 0; i < len; i++)
+               term_vspace(p);

 
 

-       term_vspace(p);
-       p->offset = INDENT;

        return(0);
 }
 
 
        return(0);
 }
 
 

+/* ARGSUSED */
+static int
+pre_br(DECL_ARGS)
+{
+
+       term_newln(p);
+       return(0);
+}
+
+
+/* ARGSUSED */
+static int
+pre_HP(DECL_ARGS)
+{
+
+       switch (n->type) {
+       case (MAN_BLOCK):
+               fmt_block_vspace(p, n);
+               break;
+       case (MAN_BODY):
+               p->flags |= TERMP_NOBREAK;
+               p->flags |= TERMP_TWOSPACE;
+               p->offset = INDENT;
+               p->rmargin = INDENT * 2;
+               break;
+       default:
+               return(0);
+       }
+
+       return(1);
+}
+
+
+/* ARGSUSED */
+static void
+post_HP(DECL_ARGS)
+{
+
+       switch (n->type) {
+       case (MAN_BODY):
+               term_flushln(p);
+               p->flags &= ~TERMP_NOBREAK;
+               p->flags &= ~TERMP_TWOSPACE;
+               p->offset = INDENT;
+               p->rmargin = p->maxrmargin;
+               break;
+       default:
+               break;
+       }
+}
+
+
+/* ARGSUSED */
+static int
+pre_PP(DECL_ARGS)
+{
+
+       switch (n->type) {
+       case (MAN_BLOCK):
+               fmt_block_vspace(p, n);
+               break;
+       default:
+               p->offset = INDENT;
+               break;
+       }
+
+       return(1);
+}
+
+

 /* ARGSUSED */
 static int
 pre_IP(DECL_ARGS)
 {
 /* ARGSUSED */
 static int
 pre_IP(DECL_ARGS)
 {

+       /* TODO */

 #if 0
        const struct man_node *nn;
 #if 0
        const struct man_node *nn;

-       size_t           offs;
-#endif
+       size_t           offs, sv;
+       int              ival;

 
 

-       term_vspace(p);
+       fmt_block_vspace(p, n);
+
+       p->flags |= TERMP_NOSPACE;
+
+       sv = p->offset;

        p->offset = INDENT;
 
        p->offset = INDENT;
 

-#if 0
-       if (NULL == (nn = n->child))
+       if (NULL == n->child)

                return(1);
                return(1);

-       if (MAN_TEXT != nn->type)
-               errx(1, "expected text line argument");

 
 

-       if (nn->next) {
-               if (MAN_TEXT != nn->next->type)
-                       errx(1, "expected text line argument");
-               offs = (size_t)atoi(nn->next->string);
-       } else
-               offs = strlen(nn->string);
+       p->flags |= TERMP_NOBREAK;
+
+       offs = sv;
+
+       /*
+        * 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;
+                       }
+               }
+               print_node(p, fl, nn, m);
+       }

 
 

-       p->flags |= TERMP_NOSPACE;
-       /* FIXME */
-       if ((p->offset += offs) > p->rmargin)
-               errx(1, "line too long");
-#endif
+       p->rmargin = p->offset + offs;
+
+       term_flushln(p);
+
+       p->offset = offs;
+       p->rmargin = p->maxrmargin;
+
+       p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;

 
        return(0);
 
        return(0);

+#endif
+       return(1);

 }
 
 
 }
 
 


@@ -308,30 +523,49 @@ pre_IP(DECL_ARGS)
 static int
 pre_TP(DECL_ARGS)
 {
 static int
 pre_TP(DECL_ARGS)
 {

-       const struct man_node *nn;
-       size_t           offs;

 
 

-       term_vspace(p);
-       p->offset = INDENT;
+       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;
+       default:
+               break;
+       }

 
 

-       if (NULL == (nn = n->child))
-               return(1);
+       return(1);
+}

 
 

-       if (nn->line == n->line) {
-               if (MAN_TEXT != nn->type)
-                       errx(1, "expected text line argument");
-               offs = (size_t)atoi(nn->string);
-               nn = nn->next;
-       } else
-               offs = INDENT;

 
 

-       for ( ; nn; nn = nn->next)
-               print_node(p, nn, m);
+/* ARGSUSED */
+static void
+post_TP(DECL_ARGS)
+{

 
 

-       term_flushln(p);
-       p->flags |= TERMP_NOSPACE;
-       p->offset += offs;
-       return(0);
+       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;
+       }

 }
 
 
 }
 
 


@@ -340,8 +574,21 @@ static int
 pre_SS(DECL_ARGS)
 {
 
 pre_SS(DECL_ARGS)
 {
 

-       term_vspace(p);
-       p->flags |= TERMP_BOLD;
+       switch (n->type) {
+       case (MAN_BLOCK):
+               term_newln(p);
+               if (n->prev)
+                       term_vspace(p);
+               break;
+       case (MAN_HEAD):
+               p->flags |= TERMP_BOLD;
+               p->offset = HALFINDENT;
+               break;
+       default:
+               p->offset = INDENT;
+               break;
+       }
+

        return(1);
 }
 
        return(1);
 }
 


@@ -351,9 +598,14 @@ static void
 post_SS(DECL_ARGS)
 {
        
 post_SS(DECL_ARGS)
 {
        

-       term_flushln(p);
-       p->flags &= ~TERMP_BOLD;
-       p->flags |= TERMP_NOSPACE;
+       switch (n->type) {
+       case (MAN_HEAD):
+               term_newln(p);
+               p->flags &= ~TERMP_BOLD;
+               break;
+       default:
+               break;
+       }

 }
 
 
 }
 
 


@@ -361,10 +613,28 @@ post_SS(DECL_ARGS)
 static int
 pre_SH(DECL_ARGS)
 {
 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):
+               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->offset = 0;
+               break;
+       case (MAN_BODY):
+               p->offset = INDENT;
+               break;
+       default:
+               break;
+       }

 
 

-       term_vspace(p);
-       p->offset = 0;
-       p->flags |= TERMP_BOLD;

        return(1);
 }
 
        return(1);
 }
 


@@ -374,10 +644,17 @@ static void
 post_SH(DECL_ARGS)
 {
        
 post_SH(DECL_ARGS)
 {
        

-       term_flushln(p);
-       p->offset = INDENT;
-       p->flags &= ~TERMP_BOLD;
-       p->flags |= TERMP_NOSPACE;
+       switch (n->type) {
+       case (MAN_HEAD):
+               term_newln(p);
+               p->flags &= ~TERMP_BOLD;
+               break;
+       case (MAN_BODY):
+               term_newln(p);
+               break;
+       default:
+               break;
+       }

 }
 
 
 }
 
 


@@ -389,10 +666,6 @@ print_node(DECL_ARGS)
        c = 1;
 
        switch (n->type) {
        c = 1;
 
        switch (n->type) {

-       case(MAN_ELEM):
-               if (termacts[n->tok].pre)
-                       c = (*termacts[n->tok].pre)(p, n, m);
-               break;

        case(MAN_TEXT):
                if (0 == *n->string) {
                        term_vspace(p);
        case(MAN_TEXT):
                if (0 == *n->string) {
                        term_vspace(p);


@@ -409,32 +682,35 @@ print_node(DECL_ARGS)
                if (sz >= 2 && n->string[sz - 1] == 'c' &&
                                n->string[sz - 2] == '\\')
                        p->flags |= TERMP_NOSPACE;
                if (sz >= 2 && n->string[sz - 1] == 'c' &&
                                n->string[sz - 2] == '\\')
                        p->flags |= TERMP_NOSPACE;

+               /* FIXME: this means that macro lines are munged!  */
+               if (MANT_LITERAL & *fl) {
+                       p->flags |= TERMP_NOSPACE;
+                       term_flushln(p);
+               }

                break;
        default:
                break;
        default:

+               if (termacts[n->tok].pre)
+                       c = (*termacts[n->tok].pre)(p, fl, n, m);

                break;
        }
 
        if (c && n->child)
                break;
        }
 
        if (c && n->child)

-               print_body(p, n->child, m);
+               print_body(p, fl, n->child, m);

 
 

-       switch (n->type) {
-       case (MAN_ELEM):
+       if (MAN_TEXT != n->type)

                if (termacts[n->tok].post)
                if (termacts[n->tok].post)

-                       (*termacts[n->tok].post)(p, n, m);
-               break;
-       default:
-               break;
-       }
+                       (*termacts[n->tok].post)(p, fl, n, m);

 }
 
 
 static void
 print_body(DECL_ARGS)
 {
 }
 
 
 static void
 print_body(DECL_ARGS)
 {

-       print_node(p, n, m);
+
+       print_node(p, fl, n, m);

        if ( ! n->next)
                return;
        if ( ! n->next)
                return;

-       print_body(p, n->next, m);
+       print_body(p, fl, n->next, m);

 }
 
 
 }