]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_term.c
Made `Cd' parseable (too many SYNOPSIS sections do this).
[mandoc.git] / mdoc_term.c
index 122e353470f43cd5637f53e3998c44425bf3c243..5c49dd7d4a0ec6e262f22461c6d3152102778f05 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.36 2009/07/12 20:30:35 kristaps Exp $ */
+/*     $Id: mdoc_term.c,v 1.47 2009/07/19 08:24:16 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -130,6 +130,7 @@ static      int       termp_ar_pre(DECL_ARGS);
 static int       termp_bd_pre(DECL_ARGS);
 static int       termp_bf_pre(DECL_ARGS);
 static int       termp_bq_pre(DECL_ARGS);
+static int       termp_br_pre(DECL_ARGS);
 static int       termp_brq_pre(DECL_ARGS);
 static int       termp_bt_pre(DECL_ARGS);
 static int       termp_cd_pre(DECL_ARGS);
@@ -147,7 +148,6 @@ static      int       termp_ft_pre(DECL_ARGS);
 static int       termp_ic_pre(DECL_ARGS);
 static int       termp_in_pre(DECL_ARGS);
 static int       termp_it_pre(DECL_ARGS);
-static int       termp_lb_pre(DECL_ARGS);
 static int       termp_lk_pre(DECL_ARGS);
 static int       termp_ms_pre(DECL_ARGS);
 static int       termp_mt_pre(DECL_ARGS);
@@ -164,6 +164,7 @@ static      int       termp_rs_pre(DECL_ARGS);
 static int       termp_rv_pre(DECL_ARGS);
 static int       termp_sh_pre(DECL_ARGS);
 static int       termp_sm_pre(DECL_ARGS);
+static int       termp_sp_pre(DECL_ARGS);
 static int       termp_sq_pre(DECL_ARGS);
 static int       termp_ss_pre(DECL_ARGS);
 static int       termp_sx_pre(DECL_ARGS);
@@ -281,7 +282,7 @@ static const struct termact termacts[MDOC_MAX] = {
        { NULL, NULL }, /* Hf */
        { NULL, NULL }, /* Fr */
        { termp_ud_pre, NULL }, /* Ud */
-       { termp_lb_pre, termp_lb_post }, /* Lb */
+       { NULL, termp_lb_post }, /* Lb */
        { termp_pp_pre, NULL }, /* Lp */ 
        { termp_lk_pre, NULL }, /* Lk */ 
        { termp_mt_pre, NULL }, /* Mt */ 
@@ -293,6 +294,8 @@ static const struct termact termacts[MDOC_MAX] = {
        { NULL, NULL }, /* En */ 
        { termp_xx_pre, NULL }, /* Dx */ 
        { NULL, NULL }, /* %Q */ 
+       { termp_br_pre, NULL }, /* br */
+       { termp_sp_pre, NULL }, /* sp */ 
 };
 
 #ifdef __linux__
@@ -361,6 +364,13 @@ print_node(DECL_ARGS)
        npair.flag = 0;
        npair.count = 0;
 
+       /*
+        * Note on termpair.  This allows a pre function to set a termp
+        * flag that is automatically unset after the body, but before
+        * the post function.  Thus, if a pre uses a termpair flag, it
+        * must be reapplied in the post for use.
+        */
+
        if (MDOC_TEXT != node->type) {
                if (termacts[node->tok].pre)
                        if ( ! (*termacts[node->tok].pre)(p, &npair, meta, node))
@@ -375,6 +385,8 @@ print_node(DECL_ARGS)
        if (dochild && node->child)
                print_body(p, &npair, meta, node->child);
 
+       p->flags &= ~npair.flag;
+
        /* Post-processing. */
 
        if (MDOC_TEXT != node->type)
@@ -383,7 +395,6 @@ print_node(DECL_ARGS)
 
        p->offset = offset;
        p->rmargin = rmargin;
-       p->flags &= ~npair.flag;
 }
 
 
@@ -408,7 +419,7 @@ print_foot(struct termp *p, const struct mdoc_meta *meta)
 
        tm = localtime(&meta->date);
 
-       if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm))
+       if (0 == strftime(buf, p->rmargin, "%B %e, %Y", tm))
                err(1, "strftime");
 
        (void)strlcpy(os, meta->os, p->rmargin);
@@ -518,28 +529,26 @@ print_head(struct termp *p, const struct mdoc_meta *meta)
 static size_t
 arg_width(const struct mdoc_argv *arg, int pos)
 {
-       size_t           v;
        int              i, len;
+       const char      *p;
 
        assert(pos < (int)arg->sz && pos >= 0);
        assert(arg->value[pos]);
 
-       if (0 == (len = (int)strlen(arg->value[pos])))
+       p = arg->value[pos];
+
+       if (0 == (len = (int)strlen(p)))
                return(0);
 
        for (i = 0; i < len - 1; i++) 
-               if ( ! isdigit((u_char)arg->value[pos][i]))
+               if ( ! isdigit((u_char)p[i]))
                        break;
 
-       if (i == len - 1) {
-               if ('n' == arg->value[pos][len - 1] ||
-                               'm' == arg->value[pos][len - 1]) {
-                       v = (size_t)atoi(arg->value[pos]);
-                       return(v + 2);
-               }
+       if (i == len - 1) 
+               if ('n' == p[len - 1] || 'm' == p[len - 1])
+                       return((size_t)atoi(p) + 2);
 
-       }
-       return(strlen(arg->value[pos]) + 2);
+       return((size_t)len + 2);
 }
 
 
@@ -572,34 +581,46 @@ arg_listtype(const struct mdoc_node *n)
                        /* FALLTHROUGH */
                case (MDOC_Column):
                        /* FALLTHROUGH */
+               case (MDOC_Hang):
+                       /* FALLTHROUGH */
                case (MDOC_Ohang):
                        return(n->args->argv[i].arg);
                default:
                        break;
                }
 
-       /* FIXME: mandated by parser. */
-
-       errx(1, "list type not supported");
-       /* NOTREACHED */
+       return(-1);
 }
 
 
 static size_t
 arg_offset(const struct mdoc_argv *arg)
 {
+       int              len, i;
+       const char      *p;
 
        assert(*arg->value);
-       if (0 == strcmp(*arg->value, "left"))
+       p = *arg->value;
+
+       if (0 == strcmp(p, "left"))
                return(0);
-       if (0 == strcmp(*arg->value, "indent"))
+       if (0 == strcmp(p, "indent"))
                return(INDENT + 1);
-       if (0 == strcmp(*arg->value, "indent-two"))
+       if (0 == strcmp(p, "indent-two"))
                return((INDENT + 1) * 2);
 
-       /* FIXME: needs to support field-widths (10n, etc.). */
+       if (0 == (len = (int)strlen(p)))
+               return(0);
+
+       for (i = 0; i < len - 1; i++) 
+               if ( ! isdigit((u_char)p[i]))
+                       break;
+
+       if (i == len - 1) 
+               if ('n' == p[len - 1] || 'm' == p[len - 1])
+                       return((size_t)atoi(p));
 
-       return(strlen(*arg->value));
+       return((size_t)len);
 }
 
 
@@ -702,7 +723,7 @@ termp_it_pre(DECL_ARGS)
 {
        const struct mdoc_node *bl, *n;
        char                    buf[7];
-       int                     i, type, keys[3], vals[3], sv;
+       int                     i, type, keys[3], vals[3];
        size_t                  width, offset;
 
        if (MDOC_BLOCK == node->type)
@@ -727,6 +748,7 @@ termp_it_pre(DECL_ARGS)
        (void)arg_getattrs(keys, vals, 3, bl);
 
        type = arg_listtype(bl);
+       assert(-1 != type);
 
        /* Calculate real width and offset. */
 
@@ -753,7 +775,7 @@ termp_it_pre(DECL_ARGS)
        /* 
         * List-type can override the width in the case of fixed-head
         * values (bullet, dash/hyphen, enum).  Tags need a non-zero
-        * offset.
+        * offset.  FIXME: double-check that correct.
         */
 
        switch (type) {
@@ -769,6 +791,10 @@ termp_it_pre(DECL_ARGS)
                if (width < 5)
                        width = 5;
                break;
+       case (MDOC_Hang):
+               if (0 == width)
+                       width = 8;
+               break;
        case (MDOC_Tag):
                if (0 == width)
                        width = 10;
@@ -783,9 +809,6 @@ termp_it_pre(DECL_ARGS)
         */
 
        switch (type) {
-       case (MDOC_Diag):
-               term_word(p, "\\ ");
-               /* FALLTHROUGH */
        case (MDOC_Inset):
                if (MDOC_BODY == node->type) 
                        p->flags &= ~TERMP_NOSPACE;
@@ -826,16 +849,30 @@ termp_it_pre(DECL_ARGS)
        case (MDOC_Enum):
                /* FALLTHROUGH */
        case (MDOC_Hyphen):
-               /* FALLTHROUGH */
+               if (MDOC_HEAD == node->type)
+                       p->flags |= TERMP_NOBREAK;
+               else
+                       p->flags |= TERMP_NOLPAD;
+               break;
+       case (MDOC_Hang):
+               if (MDOC_HEAD == node->type)
+                       p->flags |= TERMP_NOBREAK;
+               else
+                       p->flags |= TERMP_NOLPAD;
+
+               if (MDOC_HEAD == node->type)
+                       p->flags |= TERMP_HANG;
+               break;
        case (MDOC_Tag):
                if (MDOC_HEAD == node->type)
                        p->flags |= TERMP_NOBREAK;
                else
                        p->flags |= TERMP_NOLPAD;
-               if (MDOC_HEAD == node->type && MDOC_Tag == type)
-                       if (NULL == node->next ||
-                                       NULL == node->next->child)
-                               p->flags |= TERMP_NONOBREAK;
+
+               if (MDOC_HEAD != node->type)
+                       break;
+               if (NULL == node->next || NULL == node->next->child)
+                       p->flags |= TERMP_DANGLE;
                break;
        case (MDOC_Column):
                if (MDOC_HEAD == node->type) {
@@ -873,6 +910,8 @@ termp_it_pre(DECL_ARGS)
                /* FALLTHROUGH */
        case (MDOC_Hyphen):
                /* FALLTHROUGH */
+       case (MDOC_Hang):
+               /* FALLTHROUGH */
        case (MDOC_Tag):
                if (MDOC_HEAD == node->type)
                        p->rmargin = p->offset + width;
@@ -891,18 +930,19 @@ termp_it_pre(DECL_ARGS)
         * HEAD character (temporarily bold, in some cases).  
         */
 
-       sv = p->flags;
        if (MDOC_HEAD == node->type)
                switch (type) {
                case (MDOC_Bullet):
                        p->flags |= TERMP_BOLD;
                        term_word(p, "\\[bu]");
+                       p->flags &= ~TERMP_BOLD;
                        break;
                case (MDOC_Dash):
                        /* FALLTHROUGH */
                case (MDOC_Hyphen):
                        p->flags |= TERMP_BOLD;
                        term_word(p, "\\(hy");
+                       p->flags &= ~TERMP_BOLD;
                        break;
                case (MDOC_Enum):
                        (pair->ppair->ppair->count)++;
@@ -914,8 +954,6 @@ termp_it_pre(DECL_ARGS)
                        break;
                }
 
-       p->flags = sv; /* Restore saved flags. */
-
        /* 
         * If we're not going to process our children, indicate so here.
         */
@@ -955,9 +993,11 @@ termp_it_post(DECL_ARGS)
                return;
 
        type = arg_listtype(node->parent->parent->parent);
+       assert(-1 != type);
 
        switch (type) {
        case (MDOC_Diag):
+               term_word(p, "\\ ");
                /* FALLTHROUGH */
        case (MDOC_Item):
                /* FALLTHROUGH */
@@ -1110,13 +1150,8 @@ termp_nd_pre(DECL_ARGS)
        if (MDOC_BODY != node->type)
                return(1);
 
-       /* 
-        * XXX: signed off by jmc@openbsd.org.  This technically
-        * produces a minus sign after the Nd, which is wrong, but is
-        * consistent with the historic OpenBSD tmac file.
-        */
 #if defined(__OpenBSD__) || defined(__linux__)
-       term_word(p, "\\-");
+       term_word(p, "\\(en");
 #else
        term_word(p, "\\(em");
 #endif
@@ -1283,23 +1318,6 @@ termp_bt_pre(DECL_ARGS)
 }
 
 
-/* ARGSUSED */
-static int
-termp_lb_pre(DECL_ARGS)
-{
-       const char      *lb;
-
-       assert(node->child && MDOC_TEXT == node->child->type);
-       lb = mdoc_a2lib(node->child->string);
-       if (lb) {
-               term_word(p, lb);
-               return(0);
-       }
-       term_word(p, "library");
-       return(1);
-}
-
-
 /* ARGSUSED */
 static void
 termp_lb_post(DECL_ARGS)
@@ -1551,7 +1569,6 @@ termp_bd_pre(DECL_ARGS)
         * Ew.
         */
 
-       p->flags |= TERMP_LITERAL;
        ln = node->child ? node->child->line : 0;
 
        for (node = node->child; node; node = node->next) {
@@ -1574,10 +1591,7 @@ termp_bd_post(DECL_ARGS)
 
        if (MDOC_BODY != node->type) 
                return;
-
        term_flushln(p);
-       p->flags &= ~TERMP_LITERAL;
-       p->flags |= TERMP_NOSPACE;
 }
 
 
@@ -1804,8 +1818,9 @@ static void
 termp_in_post(DECL_ARGS)
 {
 
-       p->flags |= TERMP_NOSPACE;
+       p->flags |= TERMP_NOSPACE | ttypes[TTYPE_INCLUDE];
        term_word(p, ">");
+       p->flags &= ~ttypes[TTYPE_INCLUDE];
 
        if (SEC_SYNOPSIS != node->sec)
                return;
@@ -1822,6 +1837,37 @@ termp_in_post(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
+static int
+termp_sp_pre(DECL_ARGS)
+{
+       int              i, len;
+
+       if (NULL == node->child) {
+               term_vspace(p);
+               return(0);
+       }
+
+       len = atoi(node->child->string);
+       if (0 == len)
+               term_newln(p);
+       for (i = 0; i < len; i++)
+               term_vspace(p);
+
+       return(0);
+}
+
+
+/* ARGSUSED */
+static int
+termp_br_pre(DECL_ARGS)
+{
+
+       term_newln(p);
+       return(1);
+}
+
+
 /* ARGSUSED */
 static int
 termp_brq_pre(DECL_ARGS)