Make the generated man(7) code more portable by using .PD

[mandoc.git] / man_term.c

diff --git a/man_term.c b/man_term.c
index 0524426dd86e50751f88c070f242a0ffcba09b08..73f501a6598f67dc771faa5b0b9a5ebbc7bc1210 100644 (file)
--- a/man_term.c
+++ b/man_term.c
@@ -1,4 +1,4 @@
-/*     $Id: man_term.c,v 1.130 2012/07/10 19:54:11 schwarze Exp $ */
+/*     $Id: man_term.c,v 1.135 2012/11/17 00:26:33 schwarze Exp $ */

 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>


@@ -35,8 +35,6 @@
 
 #define        MAXMARGINS        64 /* maximum number of indented scopes */
 
 
 #define        MAXMARGINS        64 /* maximum number of indented scopes */
 

-/* FIXME: have PD set the default vspace width. */
-

 struct mtermp {
        int               fl;
 #define        MANT_LITERAL     (1 << 0)
 struct mtermp {
        int               fl;
 #define        MANT_LITERAL     (1 << 0)


@@ -44,12 +42,13 @@ struct      mtermp {
        int               lmargincur; /* index of current margin */
        int               lmarginsz; /* actual number of nested margins */
        size_t            offset; /* default offset to visible page */
        int               lmargincur; /* index of current margin */
        int               lmarginsz; /* actual number of nested margins */
        size_t            offset; /* default offset to visible page */

+       int               pardist; /* vert. space before par., unit: [v] */

 };
 
 #define        DECL_ARGS         struct termp *p, \
                          struct mtermp *mt, \
                          const struct man_node *n, \
 };
 
 #define        DECL_ARGS         struct termp *p, \
                          struct mtermp *mt, \
                          const struct man_node *n, \

-                         const struct man_meta *m
+                         const struct man_meta *meta

 
 struct termact {
        int             (*pre)(DECL_ARGS);
 
 struct termact {
        int             (*pre)(DECL_ARGS);


@@ -66,13 +65,14 @@ static      void              print_man_node(DECL_ARGS);
 static void              print_man_head(struct termp *, const void *);
 static void              print_man_foot(struct termp *, const void *);
 static void              print_bvspace(struct termp *, 
 static void              print_man_head(struct termp *, const void *);
 static void              print_man_foot(struct termp *, const void *);
 static void              print_bvspace(struct termp *, 

-                               const struct man_node *);
+                               const struct man_node *, int);

 
 static int               pre_B(DECL_ARGS);
 static int               pre_HP(DECL_ARGS);
 static int               pre_I(DECL_ARGS);
 static int               pre_IP(DECL_ARGS);
 static int               pre_OP(DECL_ARGS);
 
 static int               pre_B(DECL_ARGS);
 static int               pre_HP(DECL_ARGS);
 static int               pre_I(DECL_ARGS);
 static int               pre_IP(DECL_ARGS);
 static int               pre_OP(DECL_ARGS);

+static int               pre_PD(DECL_ARGS);

 static int               pre_PP(DECL_ARGS);
 static int               pre_RS(DECL_ARGS);
 static int               pre_SH(DECL_ARGS);
 static int               pre_PP(DECL_ARGS);
 static int               pre_RS(DECL_ARGS);
 static int               pre_SH(DECL_ARGS);


@@ -122,7 +122,7 @@ static      const struct termact termacts[MAN_MAX] = {
        { pre_RS, post_RS, 0 }, /* RS */
        { pre_ign, NULL, 0 }, /* DT */
        { pre_ign, NULL, 0 }, /* UC */
        { pre_RS, post_RS, 0 }, /* RS */
        { pre_ign, NULL, 0 }, /* DT */
        { pre_ign, NULL, 0 }, /* UC */

-       { pre_ign, NULL, 0 }, /* PD */
+       { pre_PD, NULL, MAN_NOTEXT }, /* PD */

        { pre_ign, NULL, 0 }, /* AT */
        { pre_in, NULL, MAN_NOTEXT }, /* in */
        { pre_ft, NULL, MAN_NOTEXT }, /* ft */
        { pre_ign, NULL, 0 }, /* AT */
        { pre_in, NULL, MAN_NOTEXT }, /* in */
        { pre_ft, NULL, MAN_NOTEXT }, /* ft */


@@ -138,7 +138,7 @@ terminal_man(void *arg, const struct man *man)
 {
        struct termp            *p;
        const struct man_node   *n;
 {
        struct termp            *p;
        const struct man_node   *n;

-       const struct man_meta   *m;
+       const struct man_meta   *meta;

        struct mtermp            mt;
 
        p = (struct termp *)arg;
        struct mtermp            mt;
 
        p = (struct termp *)arg;


@@ -154,18 +154,19 @@ terminal_man(void *arg, const struct man *man)
                p->symtab = mchars_alloc();
 
        n = man_node(man);
                p->symtab = mchars_alloc();
 
        n = man_node(man);

-       m = man_meta(man);
+       meta = man_meta(man);

 
 

-       term_begin(p, print_man_head, print_man_foot, m);
+       term_begin(p, print_man_head, print_man_foot, meta);

        p->flags |= TERMP_NOSPACE;
 
        memset(&mt, 0, sizeof(struct mtermp));
 
        mt.lmargin[mt.lmargincur] = term_len(p, p->defindent);
        mt.offset = term_len(p, p->defindent);
        p->flags |= TERMP_NOSPACE;
 
        memset(&mt, 0, sizeof(struct mtermp));
 
        mt.lmargin[mt.lmargincur] = term_len(p, p->defindent);
        mt.offset = term_len(p, p->defindent);

+       mt.pardist = 1;

 
        if (n->child)
 
        if (n->child)

-               print_man_nodelist(p, &mt, n->child, m);
+               print_man_nodelist(p, &mt, n->child, meta);

 
        term_end(p);
 }
 
        term_end(p);
 }


@@ -203,8 +204,9 @@ a2width(const struct termp *p, const char *cp)
  * first, print it.
  */
 static void
  * first, print it.
  */
 static void

-print_bvspace(struct termp *p, const struct man_node *n)
+print_bvspace(struct termp *p, const struct man_node *n, int pardist)

 {
 {

+       int      i;

 
        term_newln(p);
 
 
        term_newln(p);
 


@@ -216,7 +218,8 @@ print_bvspace(struct termp *p, const struct man_node *n)
                if (NULL == n->prev)
                        return;
 
                if (NULL == n->prev)
                        return;
 

-       term_vspace(p);
+       for (i = 0; i < pardist; i++)
+               term_vspace(p);

 }
 
 /* ARGSUSED */
 }
 
 /* ARGSUSED */


@@ -265,6 +268,21 @@ pre_literal(DECL_ARGS)
        return(0);
 }
 
        return(0);
 }
 

+/* ARGSUSED */
+static int
+pre_PD(DECL_ARGS)
+{
+
+       n = n->child;
+       if (0 == n) {
+               mt->pardist = 1;
+               return(0);
+       }
+       assert(MAN_TEXT == n->type);
+       mt->pardist = atoi(n->string);
+       return(0);
+}
+

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


@@ -309,7 +327,7 @@ pre_alternate(DECL_ARGS)
                term_fontrepl(p, font[i]);
                if (savelit && NULL == nn->next)
                        mt->fl |= MANT_LITERAL;
                term_fontrepl(p, font[i]);
                if (savelit && NULL == nn->next)
                        mt->fl |= MANT_LITERAL;

-               print_man_node(p, mt, nn, m);
+               print_man_node(p, mt, nn, meta);

                if (nn->next)
                        p->flags |= TERMP_NOSPACE;
        }
                if (nn->next)
                        p->flags |= TERMP_NOSPACE;
        }


@@ -440,28 +458,54 @@ pre_in(DECL_ARGS)
 static int
 pre_sp(DECL_ARGS)
 {
 static int
 pre_sp(DECL_ARGS)
 {

+       char            *s;

        size_t           i, len;
        size_t           i, len;

+       int              neg;

 
        if ((NULL == n->prev && n->parent)) {
 
        if ((NULL == n->prev && n->parent)) {

-               if (MAN_SS == n->parent->tok)
-                       return(0);
-               if (MAN_SH == n->parent->tok)
+               switch (n->parent->tok) {
+               case (MAN_SH):
+                       /* FALLTHROUGH */
+               case (MAN_SS):
+                       /* FALLTHROUGH */
+               case (MAN_PP):
+                       /* FALLTHROUGH */
+               case (MAN_LP):
+                       /* FALLTHROUGH */
+               case (MAN_P):
+                       /* FALLTHROUGH */

                        return(0);
                        return(0);

+               default:
+                       break;
+               }

        }
 
        }
 

+       neg = 0;

        switch (n->tok) {
        case (MAN_br):
                len = 0;
                break;
        default:
        switch (n->tok) {
        case (MAN_br):
                len = 0;
                break;
        default:

-               len = n->child ? a2height(p, n->child->string) : 1;
+               if (NULL == n->child) {
+                       len = 1;
+                       break;
+               }
+               s = n->child->string;
+               if ('-' == *s) {
+                       neg = 1;
+                       s++;
+               }
+               len = a2height(p, s);

                break;
        }
 
        if (0 == len)
                term_newln(p);
                break;
        }
 
        if (0 == len)
                term_newln(p);

-       for (i = 0; i < len; i++)
-               term_vspace(p);
+       else if (neg)
+               p->skipvsp += len;
+       else
+               for (i = 0; i < len; i++)
+                       term_vspace(p);

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


@@ -477,7 +521,7 @@ pre_HP(DECL_ARGS)
 
        switch (n->type) {
        case (MAN_BLOCK):
 
        switch (n->type) {
        case (MAN_BLOCK):

-               print_bvspace(p, n);
+               print_bvspace(p, n, mt->pardist);

                return(1);
        case (MAN_BODY):
                break;
                return(1);
        case (MAN_BODY):
                break;


@@ -540,7 +584,7 @@ pre_PP(DECL_ARGS)
        switch (n->type) {
        case (MAN_BLOCK):
                mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
        switch (n->type) {
        case (MAN_BLOCK):
                mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);

-               print_bvspace(p, n);
+               print_bvspace(p, n, mt->pardist);

                break;
        default:
                p->offset = mt->offset;
                break;
        default:
                p->offset = mt->offset;


@@ -567,7 +611,7 @@ pre_IP(DECL_ARGS)
                p->flags |= TERMP_NOBREAK;
                break;
        case (MAN_BLOCK):
                p->flags |= TERMP_NOBREAK;
                break;
        case (MAN_BLOCK):

-               print_bvspace(p, n);
+               print_bvspace(p, n, mt->pardist);

                /* FALLTHROUGH */
        default:
                return(1);
                /* FALLTHROUGH */
        default:
                return(1);


@@ -600,7 +644,7 @@ pre_IP(DECL_ARGS)
                mt->fl &= ~MANT_LITERAL;
 
                if (n->child)
                mt->fl &= ~MANT_LITERAL;
 
                if (n->child)

-                       print_man_node(p, mt, n->child, m);
+                       print_man_node(p, mt, n->child, meta);

 
                if (savelit)
                        mt->fl |= MANT_LITERAL;
 
                if (savelit)
                        mt->fl |= MANT_LITERAL;


@@ -654,7 +698,7 @@ pre_TP(DECL_ARGS)
                p->flags |= TERMP_NOSPACE;
                break;
        case (MAN_BLOCK):
                p->flags |= TERMP_NOSPACE;
                break;
        case (MAN_BLOCK):

-               print_bvspace(p, n);
+               print_bvspace(p, n, mt->pardist);

                /* FALLTHROUGH */
        default:
                return(1);
                /* FALLTHROUGH */
        default:
                return(1);


@@ -685,7 +729,7 @@ pre_TP(DECL_ARGS)
                /* Don't print same-line elements. */
                for (nn = n->child; nn; nn = nn->next)
                        if (nn->line > n->line)
                /* Don't print same-line elements. */
                for (nn = n->child; nn; nn = nn->next)
                        if (nn->line > n->line)

-                               print_man_node(p, mt, nn, m);
+                               print_man_node(p, mt, nn, meta);

 
                if (savelit)
                        mt->fl |= MANT_LITERAL;
 
                if (savelit)
                        mt->fl |= MANT_LITERAL;


@@ -729,6 +773,7 @@ post_TP(DECL_ARGS)
 static int
 pre_SS(DECL_ARGS)
 {
 static int
 pre_SS(DECL_ARGS)
 {

+       int      i;

 
        switch (n->type) {
        case (MAN_BLOCK):
 
        switch (n->type) {
        case (MAN_BLOCK):


@@ -741,11 +786,12 @@ pre_SS(DECL_ARGS)
                                break;
                if (NULL == n->prev)
                        break;
                                break;
                if (NULL == n->prev)
                        break;

-               term_vspace(p);
+               for (i = 0; i < mt->pardist; i++)
+                       term_vspace(p);

                break;
        case (MAN_HEAD):
                term_fontrepl(p, TERMFONT_BOLD);
                break;
        case (MAN_HEAD):
                term_fontrepl(p, TERMFONT_BOLD);

-               p->offset = term_len(p, p->defindent/2);
+               p->offset = term_len(p, 3);

                break;
        case (MAN_BODY):
                p->offset = mt->offset;
                break;
        case (MAN_BODY):
                p->offset = mt->offset;


@@ -780,6 +826,7 @@ post_SS(DECL_ARGS)
 static int
 pre_SH(DECL_ARGS)
 {
 static int
 pre_SH(DECL_ARGS)
 {

+       int      i;

 
        switch (n->type) {
        case (MAN_BLOCK):
 
        switch (n->type) {
        case (MAN_BLOCK):


@@ -793,7 +840,8 @@ pre_SH(DECL_ARGS)
                /* If the first macro, no vspae. */
                if (NULL == n->prev)
                        break;
                /* If the first macro, no vspae. */
                if (NULL == n->prev)
                        break;

-               term_vspace(p);
+               for (i = 0; i < mt->pardist; i++)
+                       term_vspace(p);

                break;
        case (MAN_HEAD):
                term_fontrepl(p, TERMFONT_BOLD);
                break;
        case (MAN_HEAD):
                term_fontrepl(p, TERMFONT_BOLD);


@@ -934,13 +982,13 @@ print_man_node(DECL_ARGS)
 
        c = 1;
        if (termacts[n->tok].pre)
 
        c = 1;
        if (termacts[n->tok].pre)

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

 
        if (c && n->child)
 
        if (c && n->child)

-               print_man_nodelist(p, mt, n->child, m);
+               print_man_nodelist(p, mt, n->child, meta);

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

-               (*termacts[n->tok].post)(p, mt, n, m);
+               (*termacts[n->tok].post)(p, mt, n, meta);

        if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
                term_fontrepl(p, TERMFONT_NONE);
 
        if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
                term_fontrepl(p, TERMFONT_NONE);
 


@@ -978,10 +1026,10 @@ static void
 print_man_nodelist(DECL_ARGS)
 {
 
 print_man_nodelist(DECL_ARGS)
 {
 

-       print_man_node(p, mt, n, m);
+       print_man_node(p, mt, n, meta);

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

-       print_man_nodelist(p, mt, n->next, m);
+       print_man_nodelist(p, mt, n->next, meta);

 }
 
 
 }
 
 


@@ -1056,21 +1104,21 @@ print_man_head(struct termp *p, const void *arg)
 {
        char            buf[BUFSIZ], title[BUFSIZ];
        size_t          buflen, titlen;
 {
        char            buf[BUFSIZ], title[BUFSIZ];
        size_t          buflen, titlen;

-       const struct man_meta *m;
+       const struct man_meta *meta;

 
 

-       m = (const struct man_meta *)arg;
-       assert(m->title);
-       assert(m->msec);
+       meta = (const struct man_meta *)arg;
+       assert(meta->title);
+       assert(meta->msec);

 
 

-       if (m->vol)
-               strlcpy(buf, m->vol, BUFSIZ);
+       if (meta->vol)
+               strlcpy(buf, meta->vol, BUFSIZ);

        else
                buf[0] = '\0';
        buflen = term_strlen(p, buf);
 
        /* Top left corner: manual title and section. */
 
        else
                buf[0] = '\0';
        buflen = term_strlen(p, buf);
 
        /* Top left corner: manual title and section. */
 

-       snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec);
+       snprintf(title, BUFSIZ, "%s(%s)", meta->title, meta->msec);

        titlen = term_strlen(p, title);
 
        p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
        titlen = term_strlen(p, title);
 
        p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;