MANDOCERR_BADTAB needs checking, but .UR/.UE is done

[mandoc.git] / mdoc_term.c

diff --git a/mdoc_term.c b/mdoc_term.c
index 81e331e8b846a24d7854d5113901c44ebaeb6730..b27dc4ae2806e8ad84c86186c3a5f3cee7515035 100644 (file)
--- a/mdoc_term.c
+++ b/mdoc_term.c
@@ -1,7 +1,8 @@
-/*     $Id: mdoc_term.c,v 1.245 2012/11/17 00:26:33 schwarze Exp $ */
+/*     $Id: mdoc_term.c,v 1.259 2014/02/16 12:33:39 schwarze Exp $ */

 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

- * Copyright (c) 2010, 2012 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -100,7 +101,6 @@ static      int       termp_fl_pre(DECL_ARGS);
 static int       termp_fn_pre(DECL_ARGS);
 static int       termp_fo_pre(DECL_ARGS);
 static int       termp_ft_pre(DECL_ARGS);
 static int       termp_fn_pre(DECL_ARGS);
 static int       termp_fo_pre(DECL_ARGS);
 static int       termp_ft_pre(DECL_ARGS);

-static int       termp_igndelim_pre(DECL_ARGS);

 static int       termp_in_pre(DECL_ARGS);
 static int       termp_it_pre(DECL_ARGS);
 static int       termp_li_pre(DECL_ARGS);
 static int       termp_in_pre(DECL_ARGS);
 static int       termp_it_pre(DECL_ARGS);
 static int       termp_li_pre(DECL_ARGS);


@@ -194,12 +194,12 @@ static    const struct termact termacts[MDOC_MAX] = {
        { termp_quote_pre, termp_quote_post }, /* Eo */
        { termp_xx_pre, NULL }, /* Fx */
        { termp_bold_pre, NULL }, /* Ms */
        { termp_quote_pre, termp_quote_post }, /* Eo */
        { termp_xx_pre, NULL }, /* Fx */
        { termp_bold_pre, NULL }, /* Ms */

-       { termp_igndelim_pre, NULL }, /* No */
+       { NULL, NULL }, /* No */

        { termp_ns_pre, NULL }, /* Ns */
        { termp_xx_pre, NULL }, /* Nx */
        { termp_xx_pre, NULL }, /* Ox */
        { NULL, NULL }, /* Pc */
        { termp_ns_pre, NULL }, /* Ns */
        { termp_xx_pre, NULL }, /* Nx */
        { termp_xx_pre, NULL }, /* Ox */
        { NULL, NULL }, /* Pc */

-       { termp_igndelim_pre, termp_pf_post }, /* Pf */
+       { NULL, termp_pf_post }, /* Pf */

        { termp_quote_pre, termp_quote_post }, /* Po */
        { termp_quote_pre, termp_quote_post }, /* Pq */
        { NULL, NULL }, /* Qc */
        { termp_quote_pre, termp_quote_post }, /* Po */
        { termp_quote_pre, termp_quote_post }, /* Pq */
        { NULL, NULL }, /* Qc */


@@ -307,33 +307,16 @@ print_mdoc_node(DECL_ARGS)
        /*
         * Keeps only work until the end of a line.  If a keep was
         * invoked in a prior line, revert it to PREKEEP.
        /*
         * Keeps only work until the end of a line.  If a keep was
         * invoked in a prior line, revert it to PREKEEP.

-        *
-        * Also let SYNPRETTY sections behave as if they were wrapped
-        * in a `Bk' block.

         */
 
         */
 

-       if (TERMP_KEEP & p->flags || MDOC_SYNPRETTY & n->flags) {
-               if (n->prev && n->prev->line != n->line) {
+       if (TERMP_KEEP & p->flags) {
+               if (n->prev ? (n->prev->lastline != n->line) :
+                   (n->parent && n->parent->line != n->line)) {

                        p->flags &= ~TERMP_KEEP;
                        p->flags |= TERMP_PREKEEP;
                        p->flags &= ~TERMP_KEEP;
                        p->flags |= TERMP_PREKEEP;

-               } else if (NULL == n->prev) {
-                       if (n->parent && n->parent->line != n->line) {
-                               p->flags &= ~TERMP_KEEP;
-                               p->flags |= TERMP_PREKEEP;
-                       }

                }
        }
 
                }
        }
 

-       /*
-        * Since SYNPRETTY sections aren't "turned off" with `Ek',
-        * we have to intuit whether we should disable formatting.
-        */
-
-       if ( ! (MDOC_SYNPRETTY & n->flags) &&
-           ((n->prev   && MDOC_SYNPRETTY & n->prev->flags) ||
-            (n->parent && MDOC_SYNPRETTY & n->parent->flags)))
-               p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
-

        /*
         * After the keep flags have been set up, we may now
         * produce output.  Note that some pre-handlers do so.
        /*
         * After the keep flags have been set up, we may now
         * produce output.  Note that some pre-handlers do so.


@@ -428,6 +411,7 @@ print_mdoc_foot(struct termp *p, const void *arg)
        p->offset = 0;
        p->rmargin = (p->maxrmargin - 
                        term_strlen(p, meta->date) + term_len(p, 1)) / 2;
        p->offset = 0;
        p->rmargin = (p->maxrmargin - 
                        term_strlen(p, meta->date) + term_len(p, 1)) / 2;

+       p->trailspace = 1;

        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
 
        term_word(p, meta->os);
        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
 
        term_word(p, meta->os);


@@ -442,6 +426,7 @@ print_mdoc_foot(struct termp *p, const void *arg)
 
        p->offset = p->rmargin;
        p->rmargin = p->maxrmargin;
 
        p->offset = p->rmargin;
        p->rmargin = p->maxrmargin;

+       p->trailspace = 0;

        p->flags &= ~TERMP_NOBREAK;
        p->flags |= TERMP_NOSPACE;
 
        p->flags &= ~TERMP_NOBREAK;
        p->flags |= TERMP_NOSPACE;
 


@@ -493,6 +478,7 @@ print_mdoc_head(struct termp *p, const void *arg)
        titlen = term_strlen(p, title);
 
        p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
        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 -
        p->offset = 0;
        p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
            (p->maxrmargin -


@@ -511,6 +497,7 @@ print_mdoc_head(struct termp *p, const void *arg)
        term_flushln(p);
 
        p->flags &= ~TERMP_NOBREAK;
        term_flushln(p);
 
        p->flags &= ~TERMP_NOBREAK;

+       p->trailspace = 0;

        if (p->rmargin + titlen <= p->maxrmargin) {
                p->flags |= TERMP_NOSPACE;
                p->offset = p->rmargin;
        if (p->rmargin + titlen <= p->maxrmargin) {
                p->flags |= TERMP_NOSPACE;
                p->offset = p->rmargin;


@@ -798,13 +785,13 @@ termp_it_pre(DECL_ARGS)
        case (LIST_dash):
                /* FALLTHROUGH */
        case (LIST_hyphen):
        case (LIST_dash):
                /* FALLTHROUGH */
        case (LIST_hyphen):

-               if (MDOC_HEAD == n->type)
-                       p->flags |= TERMP_NOBREAK;
+               if (MDOC_HEAD != n->type)
+                       break;
+               p->flags |= TERMP_NOBREAK;
+               p->trailspace = 1;

                break;
        case (LIST_hang):
                break;
        case (LIST_hang):

-               if (MDOC_HEAD == n->type)
-                       p->flags |= TERMP_NOBREAK;
-               else
+               if (MDOC_HEAD != n->type)

                        break;
 
                /*
                        break;
 
                /*


@@ -816,16 +803,18 @@ termp_it_pre(DECL_ARGS)
                if (n->next->child && 
                                (MDOC_Bl == n->next->child->tok ||
                                 MDOC_Bd == n->next->child->tok))
                if (n->next->child && 
                                (MDOC_Bl == n->next->child->tok ||
                                 MDOC_Bd == n->next->child->tok))

-                       p->flags &= ~TERMP_NOBREAK;
-               else
-                       p->flags |= TERMP_HANG;
+                       break;
+
+               p->flags |= TERMP_NOBREAK | TERMP_HANG;
+               p->trailspace = 1;

                break;
        case (LIST_tag):
                break;
        case (LIST_tag):

-               if (MDOC_HEAD == n->type)
-                       p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE;
-

                if (MDOC_HEAD != n->type)
                        break;
                if (MDOC_HEAD != n->type)
                        break;

+
+               p->flags |= TERMP_NOBREAK;
+               p->trailspace = 2;
+

                if (NULL == n->next || NULL == n->next->child)
                        p->flags |= TERMP_DANGLE;
                break;
                if (NULL == n->next || NULL == n->next->child)
                        p->flags |= TERMP_DANGLE;
                break;


@@ -833,15 +822,20 @@ termp_it_pre(DECL_ARGS)
                if (MDOC_HEAD == n->type)
                        break;
 
                if (MDOC_HEAD == n->type)
                        break;
 

-               if (NULL == n->next)
+               if (NULL == n->next) {

                        p->flags &= ~TERMP_NOBREAK;
                        p->flags &= ~TERMP_NOBREAK;

-               else
+                       p->trailspace = 0;
+               } else {

                        p->flags |= TERMP_NOBREAK;
                        p->flags |= TERMP_NOBREAK;

+                       p->trailspace = 1;
+               }

 
                break;
        case (LIST_diag):
 
                break;
        case (LIST_diag):

-               if (MDOC_HEAD == n->type)
-                       p->flags |= TERMP_NOBREAK;
+               if (MDOC_HEAD != n->type)
+                       break;
+               p->flags |= TERMP_NOBREAK;
+               p->trailspace = 1;

                break;
        default:
                break;
                break;
        default:
                break;


@@ -879,8 +873,11 @@ termp_it_pre(DECL_ARGS)
                assert(width);
                if (MDOC_HEAD == n->type)
                        p->rmargin = p->offset + width;
                assert(width);
                if (MDOC_HEAD == n->type)
                        p->rmargin = p->offset + width;

-               else 
+               else {

                        p->offset += width;
                        p->offset += width;

+                       if (p->rmargin < p->offset)
+                               p->rmargin = p->offset;
+               }

                break;
        case (LIST_column):
                assert(width);
                break;
        case (LIST_column):
                assert(width);


@@ -993,8 +990,8 @@ termp_it_post(DECL_ARGS)
 
        p->flags &= ~TERMP_DANGLE;
        p->flags &= ~TERMP_NOBREAK;
 
        p->flags &= ~TERMP_DANGLE;
        p->flags &= ~TERMP_NOBREAK;

-       p->flags &= ~TERMP_TWOSPACE;

        p->flags &= ~TERMP_HANG;
        p->flags &= ~TERMP_HANG;

+       p->trailspace = 0;

 }
 
 
 }
 
 


@@ -1003,8 +1000,10 @@ static int
 termp_nm_pre(DECL_ARGS)
 {
 
 termp_nm_pre(DECL_ARGS)
 {
 

-       if (MDOC_BLOCK == n->type)
+       if (MDOC_BLOCK == n->type) {
+               p->flags |= TERMP_PREKEEP;

                return(1);
                return(1);

+       }

 
        if (MDOC_BODY == n->type) {
                if (NULL == n->child)
 
        if (MDOC_BODY == n->type) {
                if (NULL == n->child)


@@ -1027,6 +1026,7 @@ termp_nm_pre(DECL_ARGS)
 
        if (MDOC_HEAD == n->type && n->next->child) {
                p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
 
        if (MDOC_HEAD == n->type && n->next->child) {
                p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;

+               p->trailspace = 1;

                p->rmargin = p->offset + term_len(p, 1);
                if (NULL == n->child) {
                        p->rmargin += term_strlen(p, meta->name);
                p->rmargin = p->offset + term_len(p, 1);
                if (NULL == n->child) {
                        p->rmargin += term_strlen(p, meta->name);


@@ -1052,9 +1052,12 @@ static void
 termp_nm_post(DECL_ARGS)
 {
 
 termp_nm_post(DECL_ARGS)
 {
 

-       if (MDOC_HEAD == n->type && n->next->child) {
+       if (MDOC_BLOCK == n->type) {
+               p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
+       } else if (MDOC_HEAD == n->type && n->next->child) {

                term_flushln(p);
                p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
                term_flushln(p);
                p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);

+               p->trailspace = 0;

        } else if (MDOC_BODY == n->type && n->child)
                term_flushln(p);
 }
        } else if (MDOC_BODY == n->type && n->child)
                term_flushln(p);
 }


@@ -1529,6 +1532,7 @@ termp_ft_pre(DECL_ARGS)
 static int
 termp_fn_pre(DECL_ARGS)
 {
 static int
 termp_fn_pre(DECL_ARGS)
 {

+       size_t           rmargin = 0;

        int              pretty;
 
        pretty = MDOC_SYNPRETTY & n->flags;
        int              pretty;
 
        pretty = MDOC_SYNPRETTY & n->flags;


@@ -1538,11 +1542,24 @@ termp_fn_pre(DECL_ARGS)
        if (NULL == (n = n->child))
                return(0);
 
        if (NULL == (n = n->child))
                return(0);
 

+       if (pretty) {
+               rmargin = p->rmargin;
+               p->rmargin = p->offset + term_len(p, 4);
+               p->flags |= TERMP_NOBREAK | TERMP_HANG;
+       }
+

        assert(MDOC_TEXT == n->type);
        term_fontpush(p, TERMFONT_BOLD);
        term_word(p, n->string);
        term_fontpop(p);
 
        assert(MDOC_TEXT == n->type);
        term_fontpush(p, TERMFONT_BOLD);
        term_word(p, n->string);
        term_fontpop(p);
 

+       if (pretty) {
+               term_flushln(p);
+               p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
+               p->offset = p->rmargin;
+               p->rmargin = rmargin;
+       }
+

        p->flags |= TERMP_NOSPACE;
        term_word(p, "(");
        p->flags |= TERMP_NOSPACE;
        p->flags |= TERMP_NOSPACE;
        term_word(p, "(");
        p->flags |= TERMP_NOSPACE;


@@ -1550,6 +1567,8 @@ termp_fn_pre(DECL_ARGS)
        for (n = n->next; n; n = n->next) {
                assert(MDOC_TEXT == n->type);
                term_fontpush(p, TERMFONT_UNDER);
        for (n = n->next; n; n = n->next) {
                assert(MDOC_TEXT == n->type);
                term_fontpush(p, TERMFONT_UNDER);

+               if (pretty)
+                       p->flags |= TERMP_NBRWORD;

                term_word(p, n->string);
                term_fontpop(p);
 
                term_word(p, n->string);
                term_fontpop(p);
 


@@ -1565,6 +1584,7 @@ termp_fn_pre(DECL_ARGS)
        if (pretty) {
                p->flags |= TERMP_NOSPACE;
                term_word(p, ";");
        if (pretty) {
                p->flags |= TERMP_NOSPACE;
                term_word(p, ";");

+               term_flushln(p);

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


@@ -1584,20 +1604,16 @@ termp_fa_pre(DECL_ARGS)
 
        for (nn = n->child; nn; nn = nn->next) {
                term_fontpush(p, TERMFONT_UNDER);
 
        for (nn = n->child; nn; nn = nn->next) {
                term_fontpush(p, TERMFONT_UNDER);

+               p->flags |= TERMP_NBRWORD;

                term_word(p, nn->string);
                term_fontpop(p);
 
                term_word(p, nn->string);
                term_fontpop(p);
 

-               if (nn->next) {
+               if (nn->next || (n->next && n->next->tok == MDOC_Fa)) {

                        p->flags |= TERMP_NOSPACE;
                        term_word(p, ",");
                }
        }
 
                        p->flags |= TERMP_NOSPACE;
                        term_word(p, ",");
                }
        }
 

-       if (n->child && n->next && n->next->tok == MDOC_Fa) {
-               p->flags |= TERMP_NOSPACE;
-               term_word(p, ",");
-       }
-

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


@@ -1756,7 +1772,8 @@ termp_xx_pre(DECL_ARGS)
                pp = "UNIX";
                break;
        default:
                pp = "UNIX";
                break;
        default:

-               break;
+               abort();
+               /* NOTREACHED */

        }
 
        term_word(p, pp);
        }
 
        term_word(p, pp);


@@ -1770,16 +1787,6 @@ termp_xx_pre(DECL_ARGS)
 }
 
 
 }
 
 

-/* ARGSUSED */
-static int
-termp_igndelim_pre(DECL_ARGS)
-{
-
-       p->flags |= TERMP_IGNDELIM;
-       return(1);
-}
-
-

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


@@ -1928,7 +1935,7 @@ termp_quote_pre(DECL_ARGS)
        case (MDOC_Do):
                /* FALLTHROUGH */
        case (MDOC_Dq):
        case (MDOC_Do):
                /* FALLTHROUGH */
        case (MDOC_Dq):

-               term_word(p, "``");
+               term_word(p, "\\(lq");

                break;
        case (MDOC_Eo):
                break;
                break;
        case (MDOC_Eo):
                break;


@@ -1949,7 +1956,7 @@ termp_quote_pre(DECL_ARGS)
        case (MDOC_So):
                /* FALLTHROUGH */
        case (MDOC_Sq):
        case (MDOC_So):
                /* FALLTHROUGH */
        case (MDOC_Sq):

-               term_word(p, "`");
+               term_word(p, "\\(oq");

                break;
        default:
                abort();
                break;
        default:
                abort();


@@ -1994,7 +2001,7 @@ termp_quote_post(DECL_ARGS)
        case (MDOC_Do):
                /* FALLTHROUGH */
        case (MDOC_Dq):
        case (MDOC_Do):
                /* FALLTHROUGH */
        case (MDOC_Dq):

-               term_word(p, "''");
+               term_word(p, "\\(rq");

                break;
        case (MDOC_Eo):
                break;
                break;
        case (MDOC_Eo):
                break;


@@ -2015,7 +2022,7 @@ termp_quote_post(DECL_ARGS)
        case (MDOC_So):
                /* FALLTHROUGH */
        case (MDOC_Sq):
        case (MDOC_So):
                /* FALLTHROUGH */
        case (MDOC_Sq):

-               term_word(p, "'");
+               term_word(p, "\\(cq");

                break;
        default:
                abort();
                break;
        default:
                abort();


@@ -2028,16 +2035,31 @@ termp_quote_post(DECL_ARGS)
 static int
 termp_fo_pre(DECL_ARGS)
 {
 static int
 termp_fo_pre(DECL_ARGS)
 {

+       size_t           rmargin = 0;
+       int              pretty;
+
+       pretty = MDOC_SYNPRETTY & n->flags;

 
        if (MDOC_BLOCK == n->type) {
                synopsis_pre(p, n);
                return(1);
        } else if (MDOC_BODY == n->type) {
 
        if (MDOC_BLOCK == n->type) {
                synopsis_pre(p, n);
                return(1);
        } else if (MDOC_BODY == n->type) {

+               if (pretty) {
+                       rmargin = p->rmargin;
+                       p->rmargin = p->offset + term_len(p, 4);
+                       p->flags |= TERMP_NOBREAK | TERMP_HANG;
+               }

                p->flags |= TERMP_NOSPACE;
                term_word(p, "(");
                p->flags |= TERMP_NOSPACE;
                p->flags |= TERMP_NOSPACE;
                term_word(p, "(");
                p->flags |= TERMP_NOSPACE;

+               if (pretty) {
+                       term_flushln(p);
+                       p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
+                       p->offset = p->rmargin;
+                       p->rmargin = rmargin;
+               }

                return(1);
                return(1);

-       } 
+       }

 
        if (NULL == n->child)
                return(0);
 
        if (NULL == n->child)
                return(0);


@@ -2065,6 +2087,7 @@ termp_fo_post(DECL_ARGS)
        if (MDOC_SYNPRETTY & n->flags) {
                p->flags |= TERMP_NOSPACE;
                term_word(p, ";");
        if (MDOC_SYNPRETTY & n->flags) {
                p->flags |= TERMP_NOSPACE;
                term_word(p, ";");

+               term_flushln(p);

        }
 }
 
        }
 }