Removed TODO that was fixed by parsing escapes in offset strings.

[mandoc.git] / mdoc_term.c

diff --git a/mdoc_term.c b/mdoc_term.c
index b134b3d1e127b8c5786e6140bcf28b0c1bf298eb..c2ba9eaf758573ef3bb32ec8d04b5773b8ca5fc8 100644 (file)
--- a/mdoc_term.c
+++ b/mdoc_term.c
@@ -1,6 +1,7 @@
-/*     $Id: mdoc_term.c,v 1.169 2010/07/03 17:17:15 kristaps Exp $ */
+/*     $Id: mdoc_term.c,v 1.185 2010/09/23 20:40:00 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -30,7 +31,6 @@
 #include "mandoc.h"
 #include "out.h"
 #include "term.h"
 #include "mandoc.h"
 #include "out.h"
 #include "term.h"

-#include "regs.h"

 #include "mdoc.h"
 #include "chars.h"
 #include "main.h"
 #include "mdoc.h"
 #include "chars.h"
 #include "main.h"


@@ -57,7 +57,6 @@ 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 size_t    a2height(const struct termp *, const char *);
 static size_t    a2offs(const struct termp *, const char *);
 

-static int       arg_getattr(int, const struct mdoc_node *);

 static void      print_bvspace(struct termp *,
                        const struct mdoc_node *,
                        const struct mdoc_node *);
 static void      print_bvspace(struct termp *,
                        const struct mdoc_node *,
                        const struct mdoc_node *);


@@ -93,6 +92,7 @@ static        void      termp_sh_post(DECL_ARGS);
 static void      termp_sq_post(DECL_ARGS);
 static void      termp_ss_post(DECL_ARGS);
 
 static void      termp_sq_post(DECL_ARGS);
 static void      termp_ss_post(DECL_ARGS);
 

+static int       termp__a_pre(DECL_ARGS);

 static int       termp_an_pre(DECL_ARGS);
 static int       termp_ap_pre(DECL_ARGS);
 static int       termp_aq_pre(DECL_ARGS);
 static int       termp_an_pre(DECL_ARGS);
 static int       termp_ap_pre(DECL_ARGS);
 static int       termp_aq_pre(DECL_ARGS);


@@ -152,7 +152,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { termp_bl_pre, termp_bl_post }, /* Bl */
        { NULL, NULL }, /* El */
        { termp_it_pre, termp_it_post }, /* It */
        { termp_bl_pre, termp_bl_post }, /* Bl */
        { NULL, NULL }, /* El */
        { termp_it_pre, termp_it_post }, /* It */

-       { NULL, NULL }, /* Ad */ 
+       { termp_under_pre, NULL }, /* Ad */ 

        { termp_an_pre, termp_an_post }, /* An */
        { termp_under_pre, NULL }, /* Ar */
        { termp_cd_pre, NULL }, /* Cd */
        { termp_an_pre, termp_an_post }, /* An */
        { termp_under_pre, NULL }, /* Ar */
        { termp_cd_pre, NULL }, /* Cd */


@@ -179,7 +179,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { termp_under_pre, NULL }, /* Va */
        { termp_vt_pre, NULL }, /* Vt */
        { termp_xr_pre, NULL }, /* Xr */
        { termp_under_pre, NULL }, /* Va */
        { termp_vt_pre, NULL }, /* Vt */
        { termp_xr_pre, NULL }, /* Xr */

-       { NULL, termp____post }, /* %A */
+       { termp__a_pre, termp____post }, /* %A */

        { termp_under_pre, termp____post }, /* %B */
        { NULL, termp____post }, /* %D */
        { termp_under_pre, termp____post }, /* %I */
        { termp_under_pre, termp____post }, /* %B */
        { NULL, termp____post }, /* %D */
        { termp_under_pre, termp____post }, /* %I */


@@ -209,7 +209,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { termp_under_pre, NULL }, /* Em */ 
        { NULL, NULL }, /* Eo */
        { termp_xx_pre, NULL }, /* Fx */
        { termp_under_pre, NULL }, /* Em */ 
        { NULL, NULL }, /* Eo */
        { termp_xx_pre, NULL }, /* Fx */

-       { termp_bold_pre, NULL }, /* Ms */ /* FIXME: convert to symbol? */
+       { termp_bold_pre, NULL }, /* Ms */

        { NULL, NULL }, /* No */
        { termp_ns_pre, NULL }, /* Ns */
        { termp_xx_pre, NULL }, /* Nx */
        { NULL, NULL }, /* No */
        { termp_ns_pre, NULL }, /* Ns */
        { termp_xx_pre, NULL }, /* Nx */


@@ -330,6 +330,23 @@ print_mdoc_node(DECL_ARGS)
        else if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
                chld = (*termacts[n->tok].pre)(p, &npair, m, n);
 
        else if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
                chld = (*termacts[n->tok].pre)(p, &npair, m, n);
 

+       /*
+        * Keeps only work until the end of a line.  If a keep was
+        * invoked in a prior line, revert it to PREKEEP.
+        */
+
+       if (TERMP_KEEP & p->flags) {
+               if (n->prev && n->prev->line != n->line) {
+                       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;
+                       }
+               }
+       }
+

        if (chld && n->child)
                print_mdoc_nodelist(p, &npair, m, n->child);
 
        if (chld && n->child)
                print_mdoc_nodelist(p, &npair, m, n->child);
 


@@ -526,26 +543,6 @@ a2offs(const struct termp *p, const char *v)
 }
 
 
 }
 
 

-/*
- * Get the index of an argument in a node's argument list or -1 if it
- * does not exist.
- */
-static int
-arg_getattr(int v, const struct mdoc_node *n)
-{
-       int              i;
-
-       if (NULL == n->args)
-               return(0);
-
-       for (i = 0; i < (int)n->args->argc; i++) 
-               if (n->args->argv[i].arg == v)
-                       return(i);
-
-       return(-1);
-}
-
-

 /*
  * Determine how much space to print out before block elements of `It'
  * (and thus `Bl') and `Bd'.  And then go ahead and print that space,
 /*
  * Determine how much space to print out before block elements of `It'
  * (and thus `Bl') and `Bd'.  And then go ahead and print that space,


@@ -631,7 +628,7 @@ termp_it_pre(DECL_ARGS)
 {
        const struct mdoc_node *bl, *nn;
        char                    buf[7];
 {
        const struct mdoc_node *bl, *nn;
        char                    buf[7];

-       int                     i, col;
+       int                     i;

        size_t                  width, offset, ncols, dcol;
        enum mdoc_list          type;
 
        size_t                  width, offset, ncols, dcol;
        enum mdoc_list          type;
 


@@ -660,8 +657,6 @@ termp_it_pre(DECL_ARGS)
                if (MDOC_HEAD == n->type)
                        break;
 
                if (MDOC_HEAD == n->type)
                        break;
 

-               col = arg_getattr(MDOC_Column, bl);
-

                /*
                 * Imitate groff's column handling:
                 * - For each earlier column, add its width.
                /*
                 * Imitate groff's column handling:
                 * - For each earlier column, add its width.


@@ -671,7 +666,8 @@ termp_it_pre(DECL_ARGS)
                 *   column.
                 * - For more than 5 columns, add only one column.
                 */
                 *   column.
                 * - For more than 5 columns, add only one column.
                 */

-               ncols = bl->args->argv[col].sz;
+               ncols = bl->data.Bl->ncols;
+

                /* LINTED */
                dcol = ncols < 5 ? term_len(p, 4) : 
                        ncols == 5 ? term_len(p, 3) : term_len(p, 1);
                /* LINTED */
                dcol = ncols < 5 ? term_len(p, 4) : 
                        ncols == 5 ? term_len(p, 3) : term_len(p, 1);


@@ -685,7 +681,7 @@ termp_it_pre(DECL_ARGS)
                                nn->prev && i < (int)ncols; 
                                nn = nn->prev, i++)
                        offset += dcol + a2width
                                nn->prev && i < (int)ncols; 
                                nn = nn->prev, i++)
                        offset += dcol + a2width

-                               (p, bl->args->argv[col].value[i]);
+                               (p, bl->data.Bl->cols[i]);

 
                /*
                 * When exceeding the declared number of columns, leave
 
                /*
                 * When exceeding the declared number of columns, leave


@@ -700,7 +696,7 @@ termp_it_pre(DECL_ARGS)
                 * Use the declared column widths, extended as explained
                 * in the preceding paragraph.
                 */
                 * Use the declared column widths, extended as explained
                 * in the preceding paragraph.
                 */

-               width = a2width(p, bl->args->argv[col].value[i]) + dcol;
+               width = a2width(p, bl->data.Bl->cols[i]) + dcol;

                break;
        default:
                if (NULL == bl->data.Bl->width)
                break;
        default:
                if (NULL == bl->data.Bl->width)


@@ -1031,15 +1027,22 @@ termp_nm_pre(DECL_ARGS)
        if (NULL == n->child && NULL == m->name)
                return(0);
 
        if (NULL == n->child && NULL == m->name)
                return(0);
 

-       synopsis_pre(p, n);
+       if (MDOC_HEAD == n->type)
+               synopsis_pre(p, n->parent);

 
        if (MDOC_HEAD == n->type && n->next->child) {
 
        if (MDOC_HEAD == n->type && n->next->child) {

-               p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_HANG;
-               p->rmargin = p->offset + term_len(p, 1) +
-                   (NULL == n->child ? term_strlen(p, m->name) :
-                    MDOC_TEXT == n->child->type ?
-                       term_strlen(p, n->child->string) :
-                    term_len(p, 5));
+               p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
+               p->rmargin = p->offset + term_len(p, 1);
+               if (NULL == n->child) {
+                       p->rmargin += term_strlen(p, m->name);
+               } else if (MDOC_TEXT == n->child->type) {
+                       p->rmargin += term_strlen(p, n->child->string);
+                       if (n->child->next)
+                               p->flags |= TERMP_HANG;
+               } else {
+                       p->rmargin += term_len(p, 5);
+                       p->flags |= TERMP_HANG;
+               }

        }
 
        term_fontpush(p, TERMFONT_BOLD);
        }
 
        term_fontpush(p, TERMFONT_BOLD);


@@ -1081,6 +1084,19 @@ termp_fl_pre(DECL_ARGS)
 }
 
 
 }
 
 

+/* ARGSUSED */
+static int
+termp__a_pre(DECL_ARGS)
+{
+
+       if (n->prev && MDOC__A == n->prev->tok)
+               if (NULL == n->next || MDOC__A != n->next->tok)
+                       term_word(p, "and");
+
+       return(1);
+}
+
+

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


@@ -1625,8 +1641,7 @@ termp_fa_pre(DECL_ARGS)
 static int
 termp_bd_pre(DECL_ARGS)
 {
 static int
 termp_bd_pre(DECL_ARGS)
 {

-       size_t                   tabwidth;
-       size_t                   rm, rmax;
+       size_t                   tabwidth, rm, rmax;

        const struct mdoc_node  *nn;
 
        if (MDOC_BLOCK == n->type) {
        const struct mdoc_node  *nn;
 
        if (MDOC_BLOCK == n->type) {


@@ -1658,12 +1673,11 @@ termp_bd_pre(DECL_ARGS)
        p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
 
        for (nn = n->child; nn; nn = nn->next) {
        p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
 
        for (nn = n->child; nn; nn = nn->next) {

-               p->flags |= TERMP_NOSPACE;

                print_mdoc_node(p, pair, m, nn);
                print_mdoc_node(p, pair, m, nn);

-               if (NULL == nn->prev ||
-                   nn->prev->line < nn->line ||
-                   NULL == nn->next)
-                       term_flushln(p);
+               if (nn->next && nn->next->line == nn->line)
+                       continue;
+               term_flushln(p);
+               p->flags |= TERMP_NOSPACE;

        }
 
        p->tabwidth = tabwidth;
        }
 
        p->tabwidth = tabwidth;


@@ -1910,6 +1924,11 @@ termp_sp_pre(DECL_ARGS)
                len = 0;
                break;
        default:
                len = 0;
                break;
        default:

+               assert(n->parent);
+               if ((NULL == n->next || NULL == n->prev) &&
+                               (MDOC_Ss == n->parent->tok ||
+                                MDOC_Sh == n->parent->tok))
+                       return(0);

                len = 1;
                break;
        }
                len = 1;
                break;
        }


@@ -2071,9 +2090,11 @@ termp_sm_pre(DECL_ARGS)
 {
 
        assert(n->child && MDOC_TEXT == n->child->type);
 {
 
        assert(n->child && MDOC_TEXT == n->child->type);

-       if (0 == strcmp("on", n->child->string))
+       if (0 == strcmp("on", n->child->string)) {
+               if (p->col)
+                       p->flags &= ~TERMP_NOSPACE;

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

-       else
+       } else

                p->flags |= TERMP_NONOSPACE;
 
        return(0);
                p->flags |= TERMP_NONOSPACE;
 
        return(0);


@@ -2097,6 +2118,16 @@ static void
 termp____post(DECL_ARGS)
 {
 
 termp____post(DECL_ARGS)
 {
 

+       /*
+        * Handle lists of authors.  In general, print each followed by
+        * a comma.  Don't print the comma if there are only two
+        * authors.
+        */
+       if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
+               if (NULL == n->next->next || MDOC__A != n->next->next->tok)
+                       if (NULL == n->prev || MDOC__A != n->prev->tok)
+                               return;
+

        /* TODO: %U. */
 
        p->flags |= TERMP_NOSPACE;
        /* TODO: %U. */
 
        p->flags |= TERMP_NOSPACE;


@@ -2118,23 +2149,25 @@ termp_li_pre(DECL_ARGS)
 static int
 termp_lk_pre(DECL_ARGS)
 {
 static int
 termp_lk_pre(DECL_ARGS)
 {

-       const struct mdoc_node *nn;
+       const struct mdoc_node *nn, *sv;

 
        term_fontpush(p, TERMFONT_UNDER);
 
        term_fontpush(p, TERMFONT_UNDER);

-       nn = n->child;
+
+       nn = sv = n->child;

 
        if (NULL == nn->next)
                return(1);
 
 
        if (NULL == nn->next)
                return(1);
 

-       term_word(p, nn->string);
+       for (nn = nn->next; nn; nn = nn->next) 
+               term_word(p, nn->string);
+

        term_fontpop(p);
 
        p->flags |= TERMP_NOSPACE;
        term_word(p, ":");
 
        term_fontpush(p, TERMFONT_BOLD);
        term_fontpop(p);
 
        p->flags |= TERMP_NOSPACE;
        term_word(p, ":");
 
        term_fontpush(p, TERMFONT_BOLD);

-       for (nn = nn->next; nn; nn = nn->next) 
-               term_word(p, nn->string);
+       term_word(p, sv->string);

        term_fontpop(p);
 
        return(0);
        term_fontpop(p);
 
        return(0);