]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_term.c
Adjust -Tman SYNOPSIS .Nm indentation using .HP; requested by millert@.
[mandoc.git] / man_term.c
index 3afea4d6fd9f891390f7e1c198dd2c7feb523f98..14e13246969d168211fa5698756a3483ff199bbc 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: man_term.c,v 1.118 2011/09/20 09:02:23 schwarze Exp $ */
+/*     $Id: man_term.c,v 1.131 2012/07/13 14:19:49 schwarze Exp $ */
 /*
- * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2011, 2012 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
@@ -33,8 +33,6 @@
 #include "term.h"
 #include "main.h"
 
-#define        INDENT            7 /* fixed-width char full-indent */
-#define        HALFINDENT        3 /* fixed-width char half-indent */
 #define        MAXMARGINS        64 /* maximum number of indented scopes */
 
 /* FIXME: have PD set the default vspace width. */
@@ -70,21 +68,22 @@ static      void              print_man_foot(struct termp *, const void *);
 static void              print_bvspace(struct termp *, 
                                const struct man_node *);
 
-static int               pre_alternate(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_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_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_sp(DECL_ARGS);
-static int               pre_ft(DECL_ARGS);
 
 static void              post_IP(DECL_ARGS);
 static void              post_HP(DECL_ARGS);
@@ -127,6 +126,9 @@ static      const struct termact termacts[MAN_MAX] = {
        { 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 */
 };
 
 
@@ -141,6 +143,9 @@ terminal_man(void *arg, const struct man *man)
 
        p = (struct termp *)arg;
 
+       if (0 == p->defindent)
+               p->defindent = 7;
+
        p->overstep = 0;
        p->maxrmargin = p->defrmargin;
        p->tabwidth = term_len(p, 5);
@@ -156,8 +161,8 @@ terminal_man(void *arg, const struct man *man)
 
        memset(&mt, 0, sizeof(struct mtermp));
 
-       mt.lmargin[mt.lmargincur] = term_len(p, INDENT);
-       mt.offset = term_len(p, INDENT);
+       mt.lmargin[mt.lmargincur] = term_len(p, p->defindent);
+       mt.offset = term_len(p, p->defindent);
 
        if (n->child)
                print_man_nodelist(p, &mt, n->child, m);
@@ -240,7 +245,7 @@ pre_literal(DECL_ARGS)
 
        term_newln(p);
 
-       if (MAN_nf == n->tok)
+       if (MAN_nf == n->tok || MAN_EX == n->tok)
                mt->fl |= MANT_LITERAL;
        else
                mt->fl &= ~MANT_LITERAL;
@@ -251,7 +256,7 @@ pre_literal(DECL_ARGS)
         * indentation has to be set up explicitly.
         */
        if (MAN_HP == n->parent->tok && p->rmargin < p->maxrmargin) {
-               p->offset = p->rmargin + 1;
+               p->offset = p->rmargin;
                p->rmargin = p->maxrmargin;
                p->flags &= ~(TERMP_NOBREAK | TERMP_TWOSPACE);
                p->flags |= TERMP_NOSPACE;
@@ -321,6 +326,29 @@ pre_B(DECL_ARGS)
        return(1);
 }
 
+/* ARGSUSED */
+static int
+pre_OP(DECL_ARGS)
+{
+
+       term_word(p, "[");
+       p->flags |= TERMP_NOSPACE;
+
+       if (NULL != (n = n->child)) {
+               term_fontrepl(p, TERMFONT_BOLD);
+               term_word(p, n->string);
+       }
+       if (NULL != n && NULL != n->next) {
+               term_fontrepl(p, TERMFONT_UNDER);
+               term_word(p, n->next->string);
+       }
+
+       term_fontrepl(p, TERMFONT_NONE);
+       p->flags |= TERMP_NOSPACE;
+       term_word(p, "]");
+       return(0);
+}
+
 /* ARGSUSED */
 static int
 pre_ft(DECL_ARGS)
@@ -412,7 +440,9 @@ pre_in(DECL_ARGS)
 static int
 pre_sp(DECL_ARGS)
 {
+       char            *s;
        size_t           i, len;
+       int              neg;
 
        if ((NULL == n->prev && n->parent)) {
                if (MAN_SS == n->parent->tok)
@@ -421,19 +451,32 @@ pre_sp(DECL_ARGS)
                        return(0);
        }
 
+       neg = 0;
        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);
-       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);
 }
@@ -452,13 +495,16 @@ pre_HP(DECL_ARGS)
                print_bvspace(p, n);
                return(1);
        case (MAN_BODY):
-               p->flags |= TERMP_NOBREAK;
-               p->flags |= TERMP_TWOSPACE;
                break;
        default:
                return(0);
        }
 
+       if ( ! (MANT_LITERAL & mt->fl)) {
+               p->flags |= TERMP_NOBREAK;
+               p->flags |= TERMP_TWOSPACE;
+       }
+
        len = mt->lmargin[mt->lmargincur];
        ival = -1;
 
@@ -469,9 +515,7 @@ pre_HP(DECL_ARGS)
                        len = (size_t)ival;
 
        one = term_len(p, 1);
-       if (len > one)
-               len -= one;
-       else
+       if (len < one)
                len = one;
 
        p->offset = mt->offset;
@@ -490,9 +534,6 @@ post_HP(DECL_ARGS)
 {
 
        switch (n->type) {
-       case (MAN_BLOCK):
-               term_flushln(p);
-               break;
        case (MAN_BODY):
                term_flushln(p);
                p->flags &= ~TERMP_NOBREAK;
@@ -513,7 +554,7 @@ pre_PP(DECL_ARGS)
 
        switch (n->type) {
        case (MAN_BLOCK):
-               mt->lmargin[mt->lmargincur] = term_len(p, INDENT);
+               mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
                print_bvspace(p, n);
                break;
        default:
@@ -640,7 +681,7 @@ pre_TP(DECL_ARGS)
        /* Calculate offset. */
 
        if (NULL != (nn = n->parent->head->child))
-               if (nn->parent->line == nn->line)
+               if (nn->string && nn->parent->line == nn->line)
                        if ((ival = a2width(p, nn->string)) >= 0)
                                len = (size_t)ival;
 
@@ -670,6 +711,8 @@ pre_TP(DECL_ARGS)
        case (MAN_BODY):
                p->offset = mt->offset + len;
                p->rmargin = p->maxrmargin;
+               p->flags &= ~TERMP_NOBREAK;
+               p->flags &= ~TERMP_TWOSPACE;
                break;
        default:
                break;
@@ -687,9 +730,6 @@ post_TP(DECL_ARGS)
        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_newln(p);
@@ -708,8 +748,8 @@ pre_SS(DECL_ARGS)
        switch (n->type) {
        case (MAN_BLOCK):
                mt->fl &= ~MANT_LITERAL;
-               mt->lmargin[mt->lmargincur] = term_len(p, INDENT);
-               mt->offset = term_len(p, INDENT);
+               mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
+               mt->offset = term_len(p, p->defindent);
                /* If following a prior empty `SS', no vspace. */
                if (n->prev && MAN_SS == n->prev->tok)
                        if (NULL == n->prev->body->child)
@@ -720,7 +760,7 @@ pre_SS(DECL_ARGS)
                break;
        case (MAN_HEAD):
                term_fontrepl(p, TERMFONT_BOLD);
-               p->offset = term_len(p, HALFINDENT);
+               p->offset = term_len(p, p->defindent/2);
                break;
        case (MAN_BODY):
                p->offset = mt->offset;
@@ -759,8 +799,8 @@ pre_SH(DECL_ARGS)
        switch (n->type) {
        case (MAN_BLOCK):
                mt->fl &= ~MANT_LITERAL;
-               mt->lmargin[mt->lmargincur] = term_len(p, INDENT);
-               mt->offset = term_len(p, INDENT);
+               mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
+               mt->offset = term_len(p, p->defindent);
                /* If following a prior empty `SH', no vspace. */
                if (n->prev && MAN_SH == n->prev->tok)
                        if (NULL == n->prev->body->child)
@@ -819,14 +859,15 @@ pre_RS(DECL_ARGS)
                break;
        }
 
-       sz = term_len(p, INDENT);
+       sz = term_len(p, p->defindent);
 
        if (NULL != (n = n->parent->head->child))
                if ((ival = a2width(p, n->string)) >= 0) 
                        sz = (size_t)ival;
 
        mt->offset += sz;
-       p->offset = mt->offset;
+       p->rmargin = p->maxrmargin;
+       p->offset = mt->offset < p->rmargin ? mt->offset : p->rmargin;
 
        if (++mt->lmarginsz < MAXMARGINS)
                mt->lmargincur = mt->lmarginsz;
@@ -852,7 +893,7 @@ post_RS(DECL_ARGS)
                break;
        }
 
-       sz = term_len(p, INDENT);
+       sz = term_len(p, p->defindent);
 
        if (NULL != (n = n->parent->head->child)) 
                if ((ival = a2width(p, n->string)) >= 0) 
@@ -885,29 +926,8 @@ print_man_node(DECL_ARGS)
                        term_newln(p);
 
                term_word(p, n->string);
+               goto out;
 
-               /*
-                * If we're in a literal context, make sure that words
-                * togehter on the same line stay together.  This is a
-                * POST-printing call, so we check the NEXT word.  Since
-                * -man doesn't have nested macros, we don't need to be
-                * more specific than this.
-                */
-               if (MANT_LITERAL & mt->fl && ! (TERMP_NOBREAK & p->flags) &&
-                               (NULL == n->next || 
-                                n->next->line > n->line)) {
-                       rm = p->rmargin;
-                       rmax = p->maxrmargin;
-                       p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
-                       p->flags |= TERMP_NOSPACE;
-                       term_flushln(p);
-                       p->rmargin = rm;
-                       p->maxrmargin = rmax;
-               }
-
-               if (MAN_EOS & n->flags)
-                       p->flags |= TERMP_SENTENCE;
-               return;
        case (MAN_EQN):
                term_eqn(p, n->eqn);
                return;
@@ -939,6 +959,31 @@ print_man_node(DECL_ARGS)
        if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
                term_fontrepl(p, TERMFONT_NONE);
 
+out:
+       /*
+        * If we're in a literal context, make sure that words
+        * together on the same line stay together.  This is a
+        * POST-printing call, so we check the NEXT word.  Since
+        * -man doesn't have nested macros, we don't need to be
+        * more specific than this.
+        */
+       if (MANT_LITERAL & mt->fl && ! (TERMP_NOBREAK & p->flags) &&
+           NULL != n->next && n->next->line > n->line) {
+               rm = p->rmargin;
+               rmax = p->maxrmargin;
+               p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
+               p->flags |= TERMP_NOSPACE;
+               if (NULL != n->string && '\0' != *n->string)
+                       term_flushln(p);
+               else
+                       term_newln(p);
+               if (rm < rmax && n->parent->tok == MAN_HP) {
+                       p->offset = rm;
+                       p->rmargin = rmax;
+               } else
+                       p->rmargin = rm;
+               p->maxrmargin = rmax;
+       }
        if (MAN_EOS & n->flags)
                p->flags |= TERMP_SENTENCE;
 }
@@ -958,37 +1003,66 @@ print_man_nodelist(DECL_ARGS)
 static void
 print_man_foot(struct termp *p, const void *arg)
 {
+       char            title[BUFSIZ];
+       size_t          datelen;
        const struct man_meta *meta;
 
        meta = (const struct man_meta *)arg;
+       assert(meta->title);
+       assert(meta->msec);
+       assert(meta->date);
 
        term_fontrepl(p, TERMFONT_NONE);
 
-       term_vspace(p);
-       term_vspace(p);
        term_vspace(p);
 
+       /*
+        * Temporary, undocumented option to imitate mdoc(7) output.
+        * In the bottom right corner, use the source instead of
+        * the title.
+        */
+
+       if ( ! p->mdocstyle) {
+               term_vspace(p);
+               term_vspace(p);
+               snprintf(title, BUFSIZ, "%s(%s)", meta->title, meta->msec);
+       } else if (meta->source) {
+               strlcpy(title, meta->source, BUFSIZ);
+       } else {
+               title[0] = '\0';
+       }
+       datelen = term_strlen(p, meta->date);
+
+       /* Bottom left corner: manual source. */
+
        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
-       p->rmargin = p->maxrmargin - term_strlen(p, meta->date);
        p->offset = 0;
-
-       /* term_strlen() can return zero. */
-       if (p->rmargin == p->maxrmargin)
-               p->rmargin--;
+       p->rmargin = (p->maxrmargin - datelen + term_len(p, 1)) / 2;
 
        if (meta->source)
                term_word(p, meta->source);
-       if (meta->source)
-               term_word(p, "");
        term_flushln(p);
 
+       /* At the bottom in the middle: manual date. */
+
        p->flags |= TERMP_NOSPACE;
        p->offset = p->rmargin;
-       p->rmargin = p->maxrmargin;
-       p->flags &= ~TERMP_NOBREAK;
+       p->rmargin = p->maxrmargin - term_strlen(p, title);
+       if (p->offset + datelen >= p->rmargin)
+               p->rmargin = p->offset + datelen;
 
        term_word(p, meta->date);
        term_flushln(p);
+
+       /* Bottom right corner: manual title and section. */
+
+       p->flags &= ~TERMP_NOBREAK;
+       p->flags |= TERMP_NOSPACE;
+       p->offset = p->rmargin;
+       p->rmargin = p->maxrmargin;
+
+       term_word(p, title);
+       term_flushln(p);
 }
 
 
@@ -1000,22 +1074,17 @@ print_man_head(struct termp *p, const void *arg)
        const struct man_meta *m;
 
        m = (const struct man_meta *)arg;
-
-       /*
-        * Note that old groff would spit out some spaces before the
-        * header.  We discontinue this strange behaviour, but at one
-        * point we did so here.
-        */
-
-       p->offset = 0;
-       p->rmargin = p->maxrmargin;
-
-       buf[0] = title[0] = '\0';
+       assert(m->title);
+       assert(m->msec);
 
        if (m->vol)
                strlcpy(buf, m->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);
        titlen = term_strlen(p, title);
 
@@ -1029,6 +1098,8 @@ print_man_head(struct termp *p, const void *arg)
        term_word(p, title);
        term_flushln(p);
 
+       /* At the top in the middle: manual volume. */
+
        p->flags |= TERMP_NOSPACE;
        p->offset = p->rmargin;
        p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?
@@ -1037,6 +1108,8 @@ print_man_head(struct termp *p, const void *arg)
        term_word(p, buf);
        term_flushln(p);
 
+       /* Top right corner: title and section, again. */
+
        p->flags &= ~TERMP_NOBREAK;
        if (p->rmargin + titlen <= p->maxrmargin) {
                p->flags |= TERMP_NOSPACE;
@@ -1051,11 +1124,14 @@ print_man_head(struct termp *p, const void *arg)
        p->rmargin = p->maxrmargin;
 
        /* 
-        * Groff likes to have some leading spaces before content.  Well
-        * that's fine by me.
+        * Groff prints three blank lines before the content.
+        * Do the same, except in the temporary, undocumented
+        * mode imitating mdoc(7) output.
         */
 
        term_vspace(p);
-       term_vspace(p);
-       term_vspace(p);
+       if ( ! p->mdocstyle) {
+               term_vspace(p);
+               term_vspace(p);
+       }
 }