]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_term.c
Delete five standards that are:
[mandoc.git] / mdoc_term.c
index 7a007e8440c6f97ce77418c94dd1dcc0d7344a46..486f1afe0b9fd27dee0988e95c3cd62678fabd10 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.269 2014/07/02 19:55:10 schwarze Exp $ */
+/*     $Id: mdoc_term.c,v 1.289 2014/11/10 21:56:43 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
@@ -16,9 +16,7 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifdef HAVE_CONFIG_H
 #include "config.h"
 #include "config.h"
-#endif
 
 #include <sys/types.h>
 
 
 #include <sys/types.h>
 
@@ -53,7 +51,6 @@ struct        termact {
 
 static size_t    a2width(const struct termp *, const char *);
 static size_t    a2height(const struct termp *, const char *);
 
 static size_t    a2width(const struct termp *, const char *);
 static size_t    a2height(const struct termp *, const char *);
-static size_t    a2offs(const struct termp *, const char *);
 
 static void      print_bvspace(struct termp *,
                        const struct mdoc_node *,
 
 static void      print_bvspace(struct termp *,
                        const struct mdoc_node *,
@@ -67,7 +64,6 @@ static        void      synopsis_pre(struct termp *,
 
 static void      termp____post(DECL_ARGS);
 static void      termp__t_post(DECL_ARGS);
 
 static void      termp____post(DECL_ARGS);
 static void      termp__t_post(DECL_ARGS);
-static void      termp_an_post(DECL_ARGS);
 static void      termp_bd_post(DECL_ARGS);
 static void      termp_bk_post(DECL_ARGS);
 static void      termp_bl_post(DECL_ARGS);
 static void      termp_bd_post(DECL_ARGS);
 static void      termp_bk_post(DECL_ARGS);
 static void      termp_bl_post(DECL_ARGS);
@@ -140,7 +136,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { NULL, NULL }, /* El */
        { termp_it_pre, termp_it_post }, /* It */
        { termp_under_pre, NULL }, /* Ad */
        { NULL, NULL }, /* El */
        { termp_it_pre, termp_it_post }, /* It */
        { termp_under_pre, NULL }, /* Ad */
-       { termp_an_pre, termp_an_post }, /* An */
+       { termp_an_pre, NULL }, /* An */
        { termp_under_pre, NULL }, /* Ar */
        { termp_cd_pre, NULL }, /* Cd */
        { termp_bold_pre, NULL }, /* Cm */
        { termp_under_pre, NULL }, /* Ar */
        { termp_cd_pre, NULL }, /* Cd */
        { termp_bold_pre, NULL }, /* Cm */
@@ -254,31 +250,41 @@ static    const struct termact termacts[MDOC_MAX] = {
 void
 terminal_mdoc(void *arg, const struct mdoc *mdoc)
 {
 void
 terminal_mdoc(void *arg, const struct mdoc *mdoc)
 {
-       const struct mdoc_node  *n;
        const struct mdoc_meta  *meta;
        const struct mdoc_meta  *meta;
+       struct mdoc_node        *n;
        struct termp            *p;
 
        p = (struct termp *)arg;
 
        struct termp            *p;
 
        p = (struct termp *)arg;
 
-       if (0 == p->defindent)
-               p->defindent = 5;
-
        p->overstep = 0;
        p->overstep = 0;
-       p->maxrmargin = p->defrmargin;
+       p->rmargin = p->maxrmargin = p->defrmargin;
        p->tabwidth = term_len(p, 5);
 
        p->tabwidth = term_len(p, 5);
 
-       if (NULL == p->symtab)
-               p->symtab = mchars_alloc();
-
-       n = mdoc_node(mdoc);
+       n = mdoc_node(mdoc)->child;
        meta = mdoc_meta(mdoc);
 
        meta = mdoc_meta(mdoc);
 
-       term_begin(p, print_mdoc_head, print_mdoc_foot, meta);
-
-       if (n->child)
-               print_mdoc_nodelist(p, NULL, meta, n->child);
-
-       term_end(p);
+       if (p->synopsisonly) {
+               while (n != NULL) {
+                       if (n->tok == MDOC_Sh && n->sec == SEC_SYNOPSIS) {
+                               if (n->child->next->child != NULL)
+                                       print_mdoc_nodelist(p, NULL,
+                                           meta, n->child->next->child);
+                               term_newln(p);
+                               break;
+                       }
+                       n = n->next;
+               }
+       } else {
+               if (p->defindent == 0)
+                       p->defindent = 5;
+               term_begin(p, print_mdoc_head, print_mdoc_foot, meta);
+               if (n != NULL) {
+                       if (n->tok != MDOC_Sh)
+                               term_vspace(p);
+                       print_mdoc_nodelist(p, NULL, meta, n);
+               }
+               term_end(p);
+       }
 }
 
 static void
 }
 
 static void
@@ -334,7 +340,11 @@ print_mdoc_node(DECL_ARGS)
                        p->flags |= TERMP_NOSPACE;
                break;
        case MDOC_EQN:
                        p->flags |= TERMP_NOSPACE;
                break;
        case MDOC_EQN:
+               if ( ! (n->flags & MDOC_LINE))
+                       p->flags |= TERMP_NOSPACE;
                term_eqn(p, n->eqn);
                term_eqn(p, n->eqn);
+               if (n->next != NULL && ! (n->next->flags & MDOC_LINE))
+                       p->flags |= TERMP_NOSPACE;
                break;
        case MDOC_TBL:
                term_tbl(p, n->span);
                break;
        case MDOC_TBL:
                term_tbl(p, n->span);
@@ -462,9 +472,6 @@ print_mdoc_head(struct termp *p, const void *arg)
         * switches on the manual section.
         */
 
         * switches on the manual section.
         */
 
-       p->offset = 0;
-       p->rmargin = p->maxrmargin;
-
        assert(meta->vol);
        if (NULL == meta->arch)
                volume = mandoc_strdup(meta->vol);
        assert(meta->vol);
        if (NULL == meta->arch)
                volume = mandoc_strdup(meta->vol);
@@ -473,7 +480,11 @@ print_mdoc_head(struct termp *p, const void *arg)
                    meta->vol, meta->arch);
        vollen = term_strlen(p, volume);
 
                    meta->vol, meta->arch);
        vollen = term_strlen(p, volume);
 
-       mandoc_asprintf(&title, "%s(%s)", meta->title, meta->msec);
+       if (NULL == meta->msec)
+               title = mandoc_strdup(meta->title);
+       else
+               mandoc_asprintf(&title, "%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;
@@ -530,27 +541,10 @@ a2width(const struct termp *p, const char *v)
        struct roffsu    su;
 
        assert(v);
        struct roffsu    su;
 
        assert(v);
-       if ( ! a2roffsu(v, &su, SCALE_MAX))
-               SCALE_HS_INIT(&su, term_strlen(p, v));
-
-       return(term_hspan(p, &su));
-}
-
-static size_t
-a2offs(const struct termp *p, const char *v)
-{
-       struct roffsu    su;
-
-       if ('\0' == *v)
-               return(0);
-       else if (0 == strcmp(v, "left"))
-               return(0);
-       else if (0 == strcmp(v, "indent"))
-               return(term_len(p, p->defindent + 1));
-       else if (0 == strcmp(v, "indent-two"))
-               return(term_len(p, (p->defindent + 1) * 2));
-       else if ( ! a2roffsu(v, &su, SCALE_MAX))
+       if ( ! a2roffsu(v, &su, SCALE_MAX)) {
                SCALE_HS_INIT(&su, term_strlen(p, v));
                SCALE_HS_INIT(&su, term_strlen(p, v));
+               su.scale /= term_strlen(p, "0");
+       }
 
        return(term_hspan(p, &su));
 }
 
        return(term_hspan(p, &su));
 }
@@ -578,16 +572,18 @@ print_bvspace(struct termp *p,
 
        /* Do not vspace directly after Ss/Sh. */
 
 
        /* Do not vspace directly after Ss/Sh. */
 
-       for (nn = n; nn; nn = nn->parent) {
-               if (MDOC_BLOCK != nn->type)
-                       continue;
-               if (MDOC_Ss == nn->tok)
-                       return;
-               if (MDOC_Sh == nn->tok)
+       nn = n;
+       while (nn->prev == NULL) {
+               do {
+                       nn = nn->parent;
+                       if (nn->type == MDOC_ROOT)
+                               return;
+               } while (nn->type != MDOC_BLOCK);
+               if (nn->tok == MDOC_Sh || nn->tok == MDOC_Ss)
                        return;
                        return;
-               if (NULL == nn->prev)
-                       continue;
-               break;
+               if (nn->tok == MDOC_It &&
+                   nn->parent->parent->norm->Bl.type != LIST_item)
+                       break;
        }
 
        /* A `-column' does not assert vspace within the list. */
        }
 
        /* A `-column' does not assert vspace within the list. */
@@ -643,7 +639,7 @@ termp_it_pre(DECL_ARGS)
        width = offset = 0;
 
        if (bl->norm->Bl.offs)
        width = offset = 0;
 
        if (bl->norm->Bl.offs)
-               offset = a2offs(p, bl->norm->Bl.offs);
+               offset = a2width(p, bl->norm->Bl.offs);
 
        switch (type) {
        case LIST_column:
 
        switch (type) {
        case LIST_column:
@@ -747,7 +743,7 @@ termp_it_pre(DECL_ARGS)
                        term_word(p, "\\ \\ ");
                break;
        case LIST_inset:
                        term_word(p, "\\ \\ ");
                break;
        case LIST_inset:
-               if (MDOC_BODY == n->type)
+               if (MDOC_BODY == n->type && n->parent->head->nchild)
                        term_word(p, "\\ ");
                break;
        default:
                        term_word(p, "\\ ");
                break;
        default:
@@ -801,7 +797,8 @@ termp_it_pre(DECL_ARGS)
                 * the "overstep" effect in term_flushln() and treat
                 * this as a `-ohang' list instead.
                 */
                 * the "overstep" effect in term_flushln() and treat
                 * this as a `-ohang' list instead.
                 */
-               if (n->next->child &&
+               if (NULL != n->next &&
+                   NULL != n->next->child &&
                    (MDOC_Bl == n->next->child->tok ||
                     MDOC_Bd == n->next->child->tok))
                        break;
                    (MDOC_Bl == n->next->child->tok ||
                     MDOC_Bd == n->next->child->tok))
                        break;
@@ -857,7 +854,9 @@ termp_it_pre(DECL_ARGS)
                 * don't want to recalculate rmargin and offsets when
                 * using `Bd' or `Bl' within `-hang' overstep lists.
                 */
                 * don't want to recalculate rmargin and offsets when
                 * using `Bd' or `Bl' within `-hang' overstep lists.
                 */
-               if (MDOC_HEAD == n->type && n->next->child &&
+               if (MDOC_HEAD == n->type &&
+                   NULL != n->next &&
+                   NULL != n->next->child &&
                    (MDOC_Bl == n->next->child->tok ||
                     MDOC_Bd == n->next->child->tok))
                        break;
                    (MDOC_Bl == n->next->child->tok ||
                     MDOC_Bd == n->next->child->tok))
                        break;
@@ -1022,7 +1021,8 @@ termp_nm_pre(DECL_ARGS)
        if (MDOC_HEAD == n->type)
                synopsis_pre(p, n->parent);
 
        if (MDOC_HEAD == n->type)
                synopsis_pre(p, n->parent);
 
-       if (MDOC_HEAD == n->type && n->next->child) {
+       if (MDOC_HEAD == n->type &&
+           NULL != n->next && NULL != n->next->child) {
                p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND;
                p->trailspace = 1;
                p->rmargin = p->offset + term_len(p, 1);
                p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND;
                p->trailspace = 1;
                p->rmargin = p->offset + term_len(p, 1);
@@ -1050,7 +1050,8 @@ termp_nm_post(DECL_ARGS)
 
        if (MDOC_BLOCK == n->type) {
                p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
 
        if (MDOC_BLOCK == n->type) {
                p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
-       } else if (MDOC_HEAD == n->type && n->next->child) {
+       } else if (MDOC_HEAD == n->type &&
+           NULL != n->next && NULL != n->next->child) {
                term_flushln(p);
                p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
                p->trailspace = 0;
                term_flushln(p);
                p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
                p->trailspace = 0;
@@ -1065,9 +1066,10 @@ termp_fl_pre(DECL_ARGS)
        term_fontpush(p, TERMFONT_BOLD);
        term_word(p, "\\-");
 
        term_fontpush(p, TERMFONT_BOLD);
        term_word(p, "\\-");
 
-       if (n->child)
-               p->flags |= TERMP_NOSPACE;
-       else if (n->next && n->next->line == n->line)
+       if ( ! (n->nchild == 0 &&
+           (n->next == NULL ||
+            n->next->type == MDOC_TEXT ||
+            n->next->flags & MDOC_LINE)))
                p->flags |= TERMP_NOSPACE;
 
        return(1);
                p->flags |= TERMP_NOSPACE;
 
        return(1);
@@ -1088,54 +1090,27 @@ static int
 termp_an_pre(DECL_ARGS)
 {
 
 termp_an_pre(DECL_ARGS)
 {
 
-       if (NULL == n->child)
-               return(1);
-
-       /*
-        * If not in the AUTHORS section, `An -split' will cause
-        * newlines to occur before the author name.  If in the AUTHORS
-        * section, by default, the first `An' invocation is nosplit,
-        * then all subsequent ones, regardless of whether interspersed
-        * with other macros/text, are split.  -split, in this case,
-        * will override the condition of the implied first -nosplit.
-        */
-
-       if (n->sec == SEC_AUTHORS) {
-               if ( ! (TERMP_ANPREC & p->flags)) {
-                       if (TERMP_SPLIT & p->flags)
-                               term_newln(p);
-                       return(1);
-               }
-               if (TERMP_NOSPLIT & p->flags)
-                       return(1);
-               term_newln(p);
-               return(1);
-       }
-
-       if (TERMP_SPLIT & p->flags)
-               term_newln(p);
-
-       return(1);
-}
-
-static void
-termp_an_post(DECL_ARGS)
-{
-
-       if (n->child) {
-               if (SEC_AUTHORS == n->sec)
-                       p->flags |= TERMP_ANPREC;
-               return;
-       }
-
-       if (AUTH_split == n->norm->An.auth) {
+       if (n->norm->An.auth == AUTH_split) {
                p->flags &= ~TERMP_NOSPLIT;
                p->flags |= TERMP_SPLIT;
                p->flags &= ~TERMP_NOSPLIT;
                p->flags |= TERMP_SPLIT;
-       } else if (AUTH_nosplit == n->norm->An.auth) {
+               return(0);
+       }
+       if (n->norm->An.auth == AUTH_nosplit) {
                p->flags &= ~TERMP_SPLIT;
                p->flags |= TERMP_NOSPLIT;
                p->flags &= ~TERMP_SPLIT;
                p->flags |= TERMP_NOSPLIT;
+               return(0);
        }
 
        }
 
+       if (n->child == NULL)
+               return(0);
+
+       if (p->flags & TERMP_SPLIT)
+               term_newln(p);
+
+       if (n->sec == SEC_AUTHORS && ! (p->flags & TERMP_NOSPLIT))
+               p->flags |= TERMP_SPLIT;
+
+       return(1);
 }
 
 static int
 }
 
 static int
@@ -1164,33 +1139,42 @@ termp_rv_pre(DECL_ARGS)
        int              nchild;
 
        term_newln(p);
        int              nchild;
 
        term_newln(p);
-       term_word(p, "The");
 
        nchild = n->nchild;
 
        nchild = n->nchild;
-       for (n = n->child; n; n = n->next) {
-               term_fontpush(p, TERMFONT_BOLD);
-               term_word(p, n->string);
-               term_fontpop(p);
+       if (nchild > 0) {
+               term_word(p, "The");
 
 
-               p->flags |= TERMP_NOSPACE;
-               term_word(p, "()");
+               for (n = n->child; n; n = n->next) {
+                       term_fontpush(p, TERMFONT_BOLD);
+                       term_word(p, n->string);
+                       term_fontpop(p);
 
 
-               if (nchild > 2 && n->next) {
                        p->flags |= TERMP_NOSPACE;
                        p->flags |= TERMP_NOSPACE;
-                       term_word(p, ",");
+                       term_word(p, "()");
+
+                       if (n->next == NULL)
+                               continue;
+
+                       if (nchild > 2) {
+                               p->flags |= TERMP_NOSPACE;
+                               term_word(p, ",");
+                       }
+                       if (n->next->next == NULL)
+                               term_word(p, "and");
                }
 
                }
 
-               if (n->next && NULL == n->next->next)
-                       term_word(p, "and");
-       }
+               if (nchild > 1)
+                       term_word(p, "functions return");
+               else
+                       term_word(p, "function returns");
 
 
-       if (nchild > 1)
-               term_word(p, "functions return");
-       else
-               term_word(p, "function returns");
+               term_word(p, "the value\\~0 if successful;");
+       } else
+               term_word(p, "Upon successful completion,"
+                   " the value\\~0 is returned;");
 
 
-       term_word(p, "the value 0 if successful; otherwise the "
-           "value -1 is returned and the global variable");
+       term_word(p, "otherwise the value\\~\\-1 is returned"
+           " and the global variable");
 
        term_fontpush(p, TERMFONT_UNDER);
        term_word(p, "errno");
 
        term_fontpush(p, TERMFONT_UNDER);
        term_word(p, "errno");
@@ -1226,11 +1210,11 @@ termp_ex_pre(DECL_ARGS)
        }
 
        if (nchild > 1)
        }
 
        if (nchild > 1)
-               term_word(p, "utilities exit");
+               term_word(p, "utilities exit\\~0");
        else
        else
-               term_word(p, "utility exits");
+               term_word(p, "utility exits\\~0");
 
 
-       term_word(p, "0 on success, and >0 if an error occurs.");
+       term_word(p, "on success, and\\~>0 if an error occurs.");
 
        p->flags |= TERMP_SENTENCE;
        return(0);
 
        p->flags |= TERMP_SENTENCE;
        return(0);
@@ -1568,7 +1552,7 @@ termp_fa_pre(DECL_ARGS)
 static int
 termp_bd_pre(DECL_ARGS)
 {
 static int
 termp_bd_pre(DECL_ARGS)
 {
-       size_t                   tabwidth, rm, rmax;
+       size_t                   tabwidth, lm, len, rm, rmax;
        struct mdoc_node        *nn;
 
        if (MDOC_BLOCK == n->type) {
        struct mdoc_node        *nn;
 
        if (MDOC_BLOCK == n->type) {
@@ -1577,8 +1561,17 @@ termp_bd_pre(DECL_ARGS)
        } else if (MDOC_HEAD == n->type)
                return(0);
 
        } else if (MDOC_HEAD == n->type)
                return(0);
 
-       if (n->norm->Bd.offs)
-               p->offset += a2offs(p, n->norm->Bd.offs);
+       /* Handle the -offset argument. */
+
+       if (n->norm->Bd.offs == NULL ||
+           ! strcmp(n->norm->Bd.offs, "left"))
+               /* nothing */;
+       else if ( ! strcmp(n->norm->Bd.offs, "indent"))
+               p->offset += term_len(p, p->defindent + 1);
+       else if ( ! strcmp(n->norm->Bd.offs, "indent-two"))
+               p->offset += term_len(p, (p->defindent + 1) * 2);
+       else
+               p->offset += a2width(p, n->norm->Bd.offs);
 
        /*
         * If -ragged or -filled are specified, the block does nothing
 
        /*
         * If -ragged or -filled are specified, the block does nothing
@@ -1589,18 +1582,29 @@ termp_bd_pre(DECL_ARGS)
         */
 
        if (DISP_literal != n->norm->Bd.type &&
         */
 
        if (DISP_literal != n->norm->Bd.type &&
-           DISP_unfilled != n->norm->Bd.type)
+           DISP_unfilled != n->norm->Bd.type &&
+           DISP_centered != n->norm->Bd.type)
                return(1);
 
        tabwidth = p->tabwidth;
        if (DISP_literal == n->norm->Bd.type)
                p->tabwidth = term_len(p, 8);
 
                return(1);
 
        tabwidth = p->tabwidth;
        if (DISP_literal == n->norm->Bd.type)
                p->tabwidth = term_len(p, 8);
 
+       lm = p->offset;
        rm = p->rmargin;
        rmax = p->maxrmargin;
        p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
 
        for (nn = n->child; nn; nn = nn->next) {
        rm = p->rmargin;
        rmax = p->maxrmargin;
        p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
 
        for (nn = n->child; nn; nn = nn->next) {
+               if (DISP_centered == n->norm->Bd.type) {
+                       if (MDOC_TEXT == nn->type) {
+                               len = term_strlen(p, nn->string);
+                               p->offset = len >= rm ? 0 :
+                                   lm + len >= rm ? rm - len :
+                                   (lm + rm - len) / 2;
+                       } else
+                               p->offset = lm;
+               }
                print_mdoc_node(p, pair, meta, nn);
                /*
                 * If the printed node flushes its own line, then we
                print_mdoc_node(p, pair, meta, nn);
                /*
                 * If the printed node flushes its own line, then we
@@ -1747,6 +1751,9 @@ termp_ss_pre(DECL_ARGS)
                term_fontpush(p, TERMFONT_BOLD);
                p->offset = term_len(p, (p->defindent+1)/2);
                break;
                term_fontpush(p, TERMFONT_BOLD);
                p->offset = term_len(p, (p->defindent+1)/2);
                break;
+       case MDOC_BODY:
+               p->offset = term_len(p, p->defindent);
+               break;
        default:
                break;
        }
        default:
                break;
        }
@@ -1758,7 +1765,7 @@ static void
 termp_ss_post(DECL_ARGS)
 {
 
 termp_ss_post(DECL_ARGS)
 {
 
-       if (MDOC_HEAD == n->type)
+       if (n->type == MDOC_HEAD || n->type == MDOC_BODY)
                term_newln(p);
 }
 
                term_newln(p);
 }