]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_term.c
Ugly fix for `Bl' or `Bd' causing badness when nested in `Bl -hang' lists.
[mandoc.git] / mdoc_term.c
index 888edef0bf3d80f4bf391eaa5d638af44cdd77b4..417ff2468d36e994ebf25fc1c095f05e64c73fae 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.53 2009/07/21 14:28:36 kristaps Exp $ */
+/*     $Id: mdoc_term.c,v 1.59 2009/07/23 09:40:25 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -50,8 +50,9 @@
 #define        TTYPE_LINK_ANCHOR 19
 #define        TTYPE_LINK_TEXT   20
 #define        TTYPE_REF_JOURNAL 21
-#define        TTYPE_LIST        22
-#define        TTYPE_NMAX        23
+#define        TTYPE_REF_TITLE   22
+#define        TTYPE_LIST        23
+#define        TTYPE_NMAX        24
 
 const  int ttypes[TTYPE_NMAX] = {
        TERMP_BOLD,             /* TTYPE_PROG */
@@ -65,7 +66,7 @@ const int ttypes[TTYPE_NMAX] = {
        TERMP_UNDER,            /* TTYPE_FUNC_ARG */
        TERMP_UNDER,            /* TTYPE_LINK */
        TERMP_BOLD,             /* TTYPE_SSECTION */
-       0,                      /* TTYPE_FILE */
+       TERMP_UNDER,            /* TTYPE_FILE */
        TERMP_UNDER,            /* TTYPE_EMPH */
        TERMP_BOLD,             /* TTYPE_CONFIG */
        TERMP_BOLD,             /* TTYPE_CMD */
@@ -76,6 +77,7 @@ const int ttypes[TTYPE_NMAX] = {
        TERMP_UNDER,            /* TTYPE_LINK_ANCHOR */
        TERMP_BOLD,             /* TTYPE_LINK_TEXT */
        TERMP_UNDER,            /* TTYPE_REF_JOURNAL */
+       TERMP_UNDER,            /* TTYPE_REF_TITLE */
        TERMP_BOLD              /* TTYPE_LIST */
 };
 
@@ -96,7 +98,6 @@ struct        termact {
 };
 
 static void      termp____post(DECL_ARGS);
-static void      termp__t_post(DECL_ARGS);
 static void      termp_aq_post(DECL_ARGS);
 static void      termp_bd_post(DECL_ARGS);
 static void      termp_bl_post(DECL_ARGS);
@@ -154,6 +155,7 @@ static      int       termp_nd_pre(DECL_ARGS);
 static int       termp_nm_pre(DECL_ARGS);
 static int       termp_ns_pre(DECL_ARGS);
 static int       termp_op_pre(DECL_ARGS);
+static int       termp_pa_pre(DECL_ARGS);
 static int       termp_pf_pre(DECL_ARGS);
 static int       termp_pp_pre(DECL_ARGS);
 static int       termp_pq_pre(DECL_ARGS);
@@ -209,7 +211,7 @@ static const struct termact termacts[MDOC_MAX] = {
        { termp_nm_pre, NULL }, /* Nm */ 
        { termp_op_pre, termp_op_post }, /* Op */
        { NULL, NULL }, /* Ot */
-       { NULL, NULL }, /* Pa */
+       { termp_pa_pre, NULL }, /* Pa */
        { termp_rv_pre, NULL }, /* Rv */
        { NULL, NULL }, /* St */ 
        { termp_va_pre, NULL }, /* Va */
@@ -224,7 +226,7 @@ static const struct termact termacts[MDOC_MAX] = {
        { NULL, termp____post }, /* %O */
        { NULL, termp____post }, /* %P */
        { NULL, termp____post }, /* %R */
-       { termp__t_pre, termp__t_post }, /* %T */
+       { termp__t_pre, termp____post }, /* %T */
        { NULL, termp____post }, /* %V */
        { NULL, NULL }, /* Ac */
        { termp_aq_pre, termp_aq_post }, /* Ao */
@@ -308,7 +310,7 @@ static      int       arg_getattr(int, const struct mdoc_node *);
 static size_t    arg_offset(const struct mdoc_argv *);
 static size_t    arg_width(const struct mdoc_argv *, int);
 static int       arg_listtype(const struct mdoc_node *);
-static int       fmt_block_vspace(struct termp *,
+static void      fmt_block_vspace(struct termp *,
                        const struct mdoc_node *,
                        const struct mdoc_node *);
 static void      print_node(DECL_ARGS);
@@ -659,7 +661,7 @@ arg_getattrs(const int *keys, int *vals,
 
 
 /* ARGSUSED */
-static int
+static void
 fmt_block_vspace(struct termp *p, 
                const struct mdoc_node *bl, 
                const struct mdoc_node *node)
@@ -668,26 +670,47 @@ fmt_block_vspace(struct termp *p,
 
        term_newln(p);
 
-       if (arg_hasattr(MDOC_Compact, bl))
-               return(1);
-       /* XXX - not documented! */
-       else if (arg_hasattr(MDOC_Column, bl))
-               return(1);
+       if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Compact, bl))
+               return;
+
+       /*
+        * Search through our prior nodes.  If we follow a `Ss' or `Sh',
+        * then don't vspace.
+        */
 
        for (n = node; n; n = n->parent) {
                if (MDOC_BLOCK != n->type)
                        continue;
                if (MDOC_Ss == n->tok)
-                       break;
+                       return;
                if (MDOC_Sh == n->tok)
-                       break;
+                       return;
                if (NULL == n->prev)
                        continue;
-               term_vspace(p);
                break;
        }
 
-       return(1);
+       /* 
+        * XXX - not documented: a `-column' does not ever assert vspace
+        * within the list.
+        */
+
+       if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Column, bl))
+               if (node->prev && MDOC_It == node->prev->tok)
+                       return;
+
+       /*
+        * XXX - not documented: a `-diag' without a body does not
+        * assert a vspace prior to the next element. 
+        */
+       if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Diag, bl)) 
+               if (node->prev && MDOC_It == node->prev->tok) {
+                       assert(node->prev->body);
+                       if (NULL == node->prev->body->child)
+                               return;
+               }
+
+       term_vspace(p);
 }
 
 
@@ -727,8 +750,10 @@ termp_it_pre(DECL_ARGS)
        int                     i, type, keys[3], vals[3];
        size_t                  width, offset;
 
-       if (MDOC_BLOCK == node->type)
-               return(fmt_block_vspace(p, node->parent->parent, node));
+       if (MDOC_BLOCK == node->type) {
+               fmt_block_vspace(p, node->parent->parent, node);
+               return(1);
+       }
 
        bl = node->parent->parent->parent;
 
@@ -757,11 +782,27 @@ termp_it_pre(DECL_ARGS)
        case (MDOC_Column):
                if (MDOC_BODY == node->type)
                        break;
-               for (i = 0, n = node->prev; n; n = n->prev, i++)
+               /* 
+                * Work around groff's column handling.  The offset is
+                * equal to the sum of all widths leading to the current
+                * column (plus the -offset value).  If this column
+                * exceeds the stated number of columns, the width is
+                * set as 0, else it's the stated column width (later
+                * the 0 will be adjusted to default 10 or, if in the
+                * last column case, set to stretch to the margin).
+                */
+               for (i = 0, n = node->prev; n && n && 
+                               i < (int)bl->args[vals[2]].argv->sz; 
+                               n = n->prev, i++)
                        offset += arg_width 
                                (&bl->args->argv[vals[2]], i);
-               assert(i < (int)bl->args->argv[vals[2]].sz);
-               width = arg_width(&bl->args->argv[vals[2]], i);
+
+               /* Whether exceeds maximum column. */
+               if (i < (int)bl->args[vals[2]].argv->sz)
+                       width = arg_width(&bl->args->argv[vals[2]], i);
+               else
+                       width = 0;
+
                if (vals[1] >= 0) 
                        offset += arg_offset(&bl->args->argv[vals[1]]);
                break;
@@ -867,7 +908,21 @@ termp_it_pre(DECL_ARGS)
                else
                        p->flags |= TERMP_NOLPAD;
 
-               if (MDOC_HEAD == node->type)
+               if (MDOC_HEAD != node->type)
+                       break;
+
+               /*
+                * This is ugly.  If `-hang' is specified and the body
+                * is a `Bl' or `Bd', then we want basically to nullify
+                * the "overstep" effect in term_flushln() and treat
+                * this as a `-ohang' list instead.
+                */
+               if (node->next->child && 
+                               (MDOC_Bl == node->next->child->tok ||
+                                MDOC_Bd == node->next->child->tok)) {
+                       p->flags &= ~TERMP_NOBREAK;
+                       p->flags &= ~TERMP_NOLPAD;
+               } else
                        p->flags |= TERMP_HANG;
                break;
        case (MDOC_Tag):
@@ -909,6 +964,17 @@ termp_it_pre(DECL_ARGS)
        p->offset += offset;
 
        switch (type) {
+       case (MDOC_Hang):
+               /*
+                * Same stipulation as above, regarding `-hang'.  We
+                * don't want to recalculate rmargin and offsets when
+                * using `Bd' or `Bl' within `-hang' overstep lists.
+                */
+               if (MDOC_HEAD == node->type && node->next->child &&
+                               (MDOC_Bl == node->next->child->tok || 
+                                MDOC_Bd == node->next->child->tok))
+                       break;
+               /* FALLTHROUGH */
        case (MDOC_Bullet):
                /* FALLTHROUGH */
        case (MDOC_Dash):
@@ -917,8 +983,6 @@ termp_it_pre(DECL_ARGS)
                /* FALLTHROUGH */
        case (MDOC_Hyphen):
                /* FALLTHROUGH */
-       case (MDOC_Hang):
-               /* FALLTHROUGH */
        case (MDOC_Tag):
                assert(width);
                if (MDOC_HEAD == node->type)
@@ -1531,9 +1595,10 @@ termp_bd_pre(DECL_ARGS)
         * line.  Blank lines are allowed.
         */
 
-       if (MDOC_BLOCK == node->type)
-               return(fmt_block_vspace(p, node, node));
-       else if (MDOC_BODY != node->type)
+       if (MDOC_BLOCK == node->type) {
+               fmt_block_vspace(p, node, node);
+               return(1);
+       } else if (MDOC_BODY != node->type)
                return(1);
 
        /* FIXME: display type should be mandated by parser. */
@@ -1707,6 +1772,16 @@ termp_sq_post(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
+static int
+termp_pa_pre(DECL_ARGS)
+{
+
+       pair->flag |= ttypes[TTYPE_FILE];
+       return(1);
+}
+
+
 /* ARGSUSED */
 static int
 termp_pf_pre(DECL_ARGS)
@@ -2081,23 +2156,11 @@ static int
 termp__t_pre(DECL_ARGS)
 {
 
-       term_word(p, "\"");
-       p->flags |= TERMP_NOSPACE;
+       pair->flag |= ttypes[TTYPE_REF_TITLE];
        return(1);
 }
 
 
-/* ARGSUSED */
-static void
-termp__t_post(DECL_ARGS)
-{
-
-       p->flags |= TERMP_NOSPACE;
-       term_word(p, "\"");
-       termp____post(p, pair, meta, node);
-}
-
-
 /* ARGSUSED */
 static void
 termp____post(DECL_ARGS)