At the end of mansearch(), fchdir() back to where we started from;

[mandoc.git] / man_term.c

diff --git a/man_term.c b/man_term.c
index 93f927d9307693656bada5682a1c56353a667e07..5a659503e3876c9813e7e0e2f28d205b7893e63c 100644 (file)
--- a/man_term.c
+++ b/man_term.c
@@ -1,7 +1,7 @@
-/*     $Id: man_term.c,v 1.132 2012/07/14 10:47:07 schwarze Exp $ */
+/*     $Id: man_term.c,v 1.145 2014/04/08 07:13:11 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -35,8 +35,6 @@
 
 #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)
@@ -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               pardist; /* vert. space before par., unit: [v] */
 };
 
 #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);
@@ -66,23 +65,26 @@ 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 *, 
-                               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_PD(DECL_ARGS);
 static int               pre_PP(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_UR(DECL_ARGS);
 static int               pre_alternate(DECL_ARGS);
 static int               pre_ft(DECL_ARGS);
 static int               pre_ign(DECL_ARGS);
 static int               pre_in(DECL_ARGS);
 static int               pre_literal(DECL_ARGS);
+static int               pre_ll(DECL_ARGS);
 static int               pre_sp(DECL_ARGS);
 
 static void              post_IP(DECL_ARGS);
@@ -91,6 +93,7 @@ static        void              post_RS(DECL_ARGS);
 static void              post_SH(DECL_ARGS);
 static void              post_SS(DECL_ARGS);
 static void              post_TP(DECL_ARGS);
+static void              post_UR(DECL_ARGS);
 
 static const struct termact termacts[MAN_MAX] = {
        { pre_sp, NULL, MAN_NOTEXT }, /* br */
@@ -122,13 +125,16 @@ static    const struct termact termacts[MAN_MAX] = {
        { 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_OP, NULL, 0 }, /* OP */
        { pre_literal, NULL, 0 }, /* EX */
        { pre_literal, NULL, 0 }, /* EE */
+       { pre_UR, post_UR, 0 }, /* UR */
+       { NULL, NULL, 0 }, /* UE */
+       { pre_ll, NULL, MAN_NOTEXT }, /* ll */
 };
 
 
@@ -138,7 +144,7 @@ terminal_man(void *arg, const struct man *man)
 {
        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;
@@ -154,18 +160,19 @@ terminal_man(void *arg, const struct man *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);
+       mt.pardist = 1;
 
        if (n->child)
-               print_man_nodelist(p, &mt, n->child, m);
+               print_man_nodelist(p, &mt, n->child, meta);
 
        term_end(p);
 }
@@ -203,8 +210,9 @@ a2width(const struct termp *p, const char *cp)
  * 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);
 
@@ -216,7 +224,8 @@ print_bvspace(struct termp *p, const struct man_node *n)
                if (NULL == n->prev)
                        return;
 
-       term_vspace(p);
+       for (i = 0; i < pardist; i++)
+               term_vspace(p);
 }
 
 /* ARGSUSED */
@@ -228,6 +237,16 @@ pre_ign(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
+static int
+pre_ll(DECL_ARGS)
+{
+
+       term_setwidth(p, n->nchild ? n->child->string : NULL);
+       return(0);
+}
+
+
 /* ARGSUSED */
 static int
 pre_I(DECL_ARGS)
@@ -258,13 +277,29 @@ pre_literal(DECL_ARGS)
        if (MAN_HP == n->parent->tok && p->rmargin < p->maxrmargin) {
                p->offset = p->rmargin;
                p->rmargin = p->maxrmargin;
-               p->flags &= ~(TERMP_NOBREAK | TERMP_TWOSPACE);
+               p->trailspace = 0;
+               p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
                p->flags |= TERMP_NOSPACE;
        }
 
        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)
@@ -309,7 +344,7 @@ pre_alternate(DECL_ARGS)
                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;
        }
@@ -503,7 +538,7 @@ pre_HP(DECL_ARGS)
 
        switch (n->type) {
        case (MAN_BLOCK):
-               print_bvspace(p, n);
+               print_bvspace(p, n, mt->pardist);
                return(1);
        case (MAN_BODY):
                break;
@@ -512,8 +547,8 @@ pre_HP(DECL_ARGS)
        }
 
        if ( ! (MANT_LITERAL & mt->fl)) {
-               p->flags |= TERMP_NOBREAK;
-               p->flags |= TERMP_TWOSPACE;
+               p->flags |= TERMP_NOBREAK | TERMP_BRIND;
+               p->trailspace = 2;
        }
 
        len = mt->lmargin[mt->lmargincur];
@@ -546,9 +581,9 @@ post_HP(DECL_ARGS)
 
        switch (n->type) {
        case (MAN_BODY):
-               term_flushln(p);
-               p->flags &= ~TERMP_NOBREAK;
-               p->flags &= ~TERMP_TWOSPACE;
+               term_newln(p);
+               p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
+               p->trailspace = 0;
                p->offset = mt->offset;
                p->rmargin = p->maxrmargin;
                break;
@@ -566,7 +601,7 @@ pre_PP(DECL_ARGS)
        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;
@@ -591,9 +626,10 @@ pre_IP(DECL_ARGS)
                break;
        case (MAN_HEAD):
                p->flags |= TERMP_NOBREAK;
+               p->trailspace = 1;
                break;
        case (MAN_BLOCK):
-               print_bvspace(p, n);
+               print_bvspace(p, n, mt->pardist);
                /* FALLTHROUGH */
        default:
                return(1);
@@ -626,7 +662,7 @@ pre_IP(DECL_ARGS)
                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;
@@ -634,7 +670,8 @@ pre_IP(DECL_ARGS)
                return(0);
        case (MAN_BODY):
                p->offset = mt->offset + len;
-               p->rmargin = p->maxrmargin;
+               p->rmargin = p->maxrmargin > p->offset ?
+                               p->maxrmargin : p->offset;
                break;
        default:
                break;
@@ -653,10 +690,12 @@ post_IP(DECL_ARGS)
        case (MAN_HEAD):
                term_flushln(p);
                p->flags &= ~TERMP_NOBREAK;
+               p->trailspace = 0;
                p->rmargin = p->maxrmargin;
                break;
        case (MAN_BODY):
                term_newln(p);
+               p->offset = mt->offset;
                break;
        default:
                break;
@@ -675,12 +714,13 @@ pre_TP(DECL_ARGS)
        switch (n->type) {
        case (MAN_HEAD):
                p->flags |= TERMP_NOBREAK;
+               p->trailspace = 1;
                break;
        case (MAN_BODY):
                p->flags |= TERMP_NOSPACE;
                break;
        case (MAN_BLOCK):
-               print_bvspace(p, n);
+               print_bvspace(p, n, mt->pardist);
                /* FALLTHROUGH */
        default:
                return(1);
@@ -692,7 +732,7 @@ pre_TP(DECL_ARGS)
        /* Calculate offset. */
 
        if (NULL != (nn = n->parent->head->child))
-               if (nn->string && nn->parent->line == nn->line)
+               if (nn->string && 0 == (MAN_LINE & nn->flags))
                        if ((ival = a2width(p, nn->string)) >= 0)
                                len = (size_t)ival;
 
@@ -709,9 +749,14 @@ pre_TP(DECL_ARGS)
                mt->fl &= ~MANT_LITERAL;
 
                /* 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);
+               nn = n->child;
+               while (NULL != nn && 0 == (MAN_LINE & nn->flags))
+                       nn = nn->next;
+
+               while (NULL != nn) {
+                       print_man_node(p, mt, nn, meta);
+                       nn = nn->next;
+               }
 
                if (savelit)
                        mt->fl |= MANT_LITERAL;
@@ -721,9 +766,10 @@ pre_TP(DECL_ARGS)
                return(0);
        case (MAN_BODY):
                p->offset = mt->offset + len;
-               p->rmargin = p->maxrmargin;
+               p->rmargin = p->maxrmargin > p->offset ?
+                               p->maxrmargin : p->offset;
+               p->trailspace = 0;
                p->flags &= ~TERMP_NOBREAK;
-               p->flags &= ~TERMP_TWOSPACE;
                break;
        default:
                break;
@@ -744,6 +790,7 @@ post_TP(DECL_ARGS)
                break;
        case (MAN_BODY):
                term_newln(p);
+               p->offset = mt->offset;
                break;
        default:
                break;
@@ -755,6 +802,7 @@ post_TP(DECL_ARGS)
 static int
 pre_SS(DECL_ARGS)
 {
+       int      i;
 
        switch (n->type) {
        case (MAN_BLOCK):
@@ -767,11 +815,12 @@ pre_SS(DECL_ARGS)
                                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);
-               p->offset = term_len(p, p->defindent/2);
+               p->offset = term_len(p, 3);
                break;
        case (MAN_BODY):
                p->offset = mt->offset;
@@ -806,6 +855,7 @@ post_SS(DECL_ARGS)
 static int
 pre_SH(DECL_ARGS)
 {
+       int      i;
 
        switch (n->type) {
        case (MAN_BLOCK):
@@ -819,7 +869,8 @@ pre_SH(DECL_ARGS)
                /* 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);
@@ -877,8 +928,9 @@ pre_RS(DECL_ARGS)
                        sz = (size_t)ival;
 
        mt->offset += sz;
-       p->rmargin = p->maxrmargin;
-       p->offset = mt->offset < p->rmargin ? mt->offset : p->rmargin;
+       p->offset = mt->offset;
+       p->rmargin = p->maxrmargin > p->offset ?
+                       p->maxrmargin : p->offset;
 
        if (++mt->lmarginsz < MAXMARGINS)
                mt->lmargincur = mt->lmarginsz;
@@ -917,6 +969,32 @@ post_RS(DECL_ARGS)
                mt->lmargincur = mt->lmarginsz;
 }
 
+/* ARGSUSED */
+static int
+pre_UR(DECL_ARGS)
+{
+
+       return (MAN_HEAD != n->type);
+}
+
+/* ARGSUSED */
+static void
+post_UR(DECL_ARGS)
+{
+
+       if (MAN_BLOCK != n->type)
+               return;
+
+       term_word(p, "<");
+       p->flags |= TERMP_NOSPACE;
+
+       if (NULL != n->child->child)
+               print_man_node(p, mt, n->child->child, meta);
+
+       p->flags |= TERMP_NOSPACE;
+       term_word(p, ">");
+}
+
 static void
 print_man_node(DECL_ARGS)
 {
@@ -960,13 +1038,13 @@ print_man_node(DECL_ARGS)
 
        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)
-               print_man_nodelist(p, mt, n->child, m);
+               print_man_nodelist(p, mt, n->child, meta);
 
        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);
 
@@ -979,7 +1057,7 @@ out:
         * more specific than this.
         */
        if (MANT_LITERAL & mt->fl && ! (TERMP_NOBREAK & p->flags) &&
-           NULL != n->next && n->next->line > n->line) {
+           (NULL == n->next || MAN_LINE & n->next->flags)) {
                rm = p->rmargin;
                rmax = p->maxrmargin;
                p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
@@ -1004,10 +1082,10 @@ static void
 print_man_nodelist(DECL_ARGS)
 {
 
-       print_man_node(p, mt, n, m);
+       print_man_node(p, mt, n, meta);
        if ( ! n->next)
                return;
-       print_man_nodelist(p, mt, n->next, m);
+       print_man_nodelist(p, mt, n->next, meta);
 }
 
 
@@ -1047,6 +1125,7 @@ print_man_foot(struct termp *p, const void *arg)
        /* Bottom left corner: manual source. */
 
        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
+       p->trailspace = 1;
        p->offset = 0;
        p->rmargin = (p->maxrmargin - datelen + term_len(p, 1)) / 2;
 
@@ -1069,6 +1148,7 @@ print_man_foot(struct termp *p, const void *arg)
 
        p->flags &= ~TERMP_NOBREAK;
        p->flags |= TERMP_NOSPACE;
+       p->trailspace = 0;
        p->offset = p->rmargin;
        p->rmargin = p->maxrmargin;
 
@@ -1082,24 +1162,25 @@ print_man_head(struct termp *p, const void *arg)
 {
        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. */
 
-       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;
+       p->trailspace = 1;
        p->offset = 0;
        p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
            (p->maxrmargin - 
@@ -1122,6 +1203,7 @@ print_man_head(struct termp *p, const void *arg)
        /* Top right corner: title and section, again. */
 
        p->flags &= ~TERMP_NOBREAK;
+       p->trailspace = 0;
        if (p->rmargin + titlen <= p->maxrmargin) {
                p->flags |= TERMP_NOSPACE;
                p->offset = p->rmargin;