]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_man.c
Bugfix: When the invocation of a user-defined macro follows a roff
[mandoc.git] / mdoc_man.c
index f5de18b0ea981c9a12cdc0a1cdcb8c6918521689..ffb141b160543b473eb90e205e5174868e91b7f4 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_man.c,v 1.67 2014/07/30 00:19:16 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.81 2014/12/24 23:32:42 schwarze Exp $ */
 /*
  * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  *
@@ -14,9 +14,9 @@
  * 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"
-#endif
+
+#include <sys/types.h>
 
 #include <assert.h>
 #include <stdio.h>
@@ -46,6 +46,7 @@ static  void    font_push(char);
 static void      font_pop(void);
 static void      mid_it(void);
 static void      post__t(DECL_ARGS);
+static void      post_aq(DECL_ARGS);
 static void      post_bd(DECL_ARGS);
 static void      post_bf(DECL_ARGS);
 static void      post_bk(DECL_ARGS);
@@ -72,6 +73,7 @@ static        void      post_vt(DECL_ARGS);
 static int       pre__t(DECL_ARGS);
 static int       pre_an(DECL_ARGS);
 static int       pre_ap(DECL_ARGS);
+static int       pre_aq(DECL_ARGS);
 static int       pre_bd(DECL_ARGS);
 static int       pre_bf(DECL_ARGS);
 static int       pre_bk(DECL_ARGS);
@@ -82,7 +84,8 @@ static        int       pre_dl(DECL_ARGS);
 static int       pre_en(DECL_ARGS);
 static int       pre_enc(DECL_ARGS);
 static int       pre_em(DECL_ARGS);
-static int       pre_es(DECL_ARGS);
+static int       pre_skip(DECL_ARGS);
+static int       pre_eo(DECL_ARGS);
 static int       pre_ex(DECL_ARGS);
 static int       pre_fa(DECL_ARGS);
 static int       pre_fd(DECL_ARGS);
@@ -112,9 +115,9 @@ static      int       pre_xr(DECL_ARGS);
 static void      print_word(const char *);
 static void      print_line(const char *, int);
 static void      print_block(const char *, int);
-static void      print_offs(const char *);
-static void      print_width(const char *,
-                               const struct mdoc_node *, size_t);
+static void      print_offs(const char *, int);
+static void      print_width(const struct mdoc_bl *,
+                       const struct mdoc_node *);
 static void      print_count(int *);
 static void      print_node(DECL_ARGS);
 
@@ -172,8 +175,8 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, pre__t, post__t, NULL, NULL }, /* %T */
        { NULL, NULL, post_percent, NULL, NULL }, /* %V */
        { NULL, NULL, NULL, NULL, NULL }, /* Ac */
-       { cond_body, pre_enc, post_enc, "<", ">" }, /* Ao */
-       { cond_body, pre_enc, post_enc, "<", ">" }, /* Aq */
+       { cond_body, pre_aq, post_aq, NULL, NULL }, /* Ao */
+       { cond_body, pre_aq, post_aq, NULL, NULL }, /* Aq */
        { NULL, NULL, NULL, NULL, NULL }, /* At */
        { NULL, NULL, NULL, NULL, NULL }, /* Bc */
        { NULL, pre_bf, post_bf, NULL, NULL }, /* Bf */
@@ -181,14 +184,14 @@ static    const struct manact manacts[MDOC_MAX + 1] = {
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Bq */
        { NULL, pre_ux, NULL, "BSD/OS", NULL }, /* Bsx */
        { NULL, pre_bx, NULL, NULL, NULL }, /* Bx */
-       { NULL, NULL, NULL, NULL, NULL }, /* Db */
+       { NULL, pre_skip, NULL, NULL, NULL }, /* Db */
        { NULL, NULL, NULL, NULL, NULL }, /* Dc */
        { cond_body, pre_enc, post_enc, "\\(lq", "\\(rq" }, /* Do */
        { cond_body, pre_enc, post_enc, "\\(lq", "\\(rq" }, /* Dq */
        { NULL, NULL, NULL, NULL, NULL }, /* Ec */
        { NULL, NULL, NULL, NULL, NULL }, /* Ef */
        { NULL, pre_em, post_font, NULL, NULL }, /* Em */
-       { NULL, NULL, post_eo, NULL, NULL }, /* Eo */
+       { cond_body, pre_eo, post_eo, NULL, NULL }, /* Eo */
        { NULL, pre_ux, NULL, "FreeBSD", NULL }, /* Fx */
        { NULL, pre_sy, post_font, NULL, NULL }, /* Ms */
        { NULL, pre_no, NULL, NULL, NULL }, /* No */
@@ -233,7 +236,7 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { cond_body, pre_enc, post_enc, "{", "}" }, /* Bro */
        { NULL, NULL, NULL, NULL, NULL }, /* Brc */
        { NULL, NULL, post_percent, NULL, NULL }, /* %C */
-       { NULL, pre_es, NULL, NULL, NULL }, /* Es */
+       { NULL, pre_skip, NULL, NULL, NULL }, /* Es */
        { cond_body, pre_en, post_en, NULL, NULL }, /* En */
        { NULL, pre_ux, NULL, "DragonFly", NULL }, /* Dx */
        { NULL, NULL, post_percent, NULL, NULL }, /* %Q */
@@ -262,7 +265,7 @@ static      int             outflags;
 
 #define        BL_STACK_MAX    32
 
-static size_t          Bl_stack[BL_STACK_MAX];  /* offsets [chars] */
+static int             Bl_stack[BL_STACK_MAX];  /* offsets [chars] */
 static int             Bl_stack_post[BL_STACK_MAX];  /* add final .RE */
 static int             Bl_stack_len;  /* number of nested Bl blocks */
 static int             TPremain;  /* characters before tag is full */
@@ -416,22 +419,22 @@ print_block(const char *s, int newflags)
 }
 
 static void
-print_offs(const char *v)
+print_offs(const char *v, int keywords)
 {
        char              buf[24];
        struct roffsu     su;
-       size_t            sz;
+       int               sz;
 
        print_line(".RS", MMAN_Bk_susp);
 
        /* Convert v into a number (of characters). */
-       if (NULL == v || '\0' == *v || 0 == strcmp(v, "left"))
+       if (NULL == v || '\0' == *v || (keywords && !strcmp(v, "left")))
                sz = 0;
-       else if (0 == strcmp(v, "indent"))
+       else if (keywords && !strcmp(v, "indent"))
                sz = 6;
-       else if (0 == strcmp(v, "indent-two"))
+       else if (keywords && !strcmp(v, "indent-two"))
                sz = 12;
-       else if (a2roffsu(v, &su, SCALE_MAX)) {
+       else if (a2roffsu(v, &su, SCALE_EN) > 1) {
                if (SCALE_EN == su.unit)
                        sz = su.scale;
                else {
@@ -456,7 +459,7 @@ print_offs(const char *v)
        if (Bl_stack_len)
                sz += Bl_stack[Bl_stack_len - 1];
 
-       (void)snprintf(buf, sizeof(buf), "%zun", sz);
+       (void)snprintf(buf, sizeof(buf), "%dn", sz);
        print_word(buf);
        outflags |= MMAN_nl;
 }
@@ -465,20 +468,19 @@ print_offs(const char *v)
  * Set up the indentation for a list item; used from pre_it().
  */
 static void
-print_width(const char *v, const struct mdoc_node *child, size_t defsz)
+print_width(const struct mdoc_bl *bl, const struct mdoc_node *child)
 {
        char              buf[24];
        struct roffsu     su;
-       size_t            sz, chsz;
-       int               numeric, remain;
+       int               numeric, remain, sz, chsz;
 
        numeric = 1;
        remain = 0;
 
-       /* Convert v into a number (of characters). */
-       if (NULL == v)
-               sz = defsz;
-       else if (a2roffsu(v, &su, SCALE_MAX)) {
+       /* Convert the width into a number (of characters). */
+       if (bl->width == NULL)
+               sz = (bl->type == LIST_hang) ? 6 : 0;
+       else if (a2roffsu(bl->width, &su, SCALE_MAX) > 1) {
                if (SCALE_EN == su.unit)
                        sz = su.scale;
                else {
@@ -486,11 +488,15 @@ print_width(const char *v, const struct mdoc_node *child, size_t defsz)
                        numeric = 0;
                }
        } else
-               sz = strlen(v);
+               sz = strlen(bl->width);
 
        /* XXX Rough estimation, might have multiple parts. */
-       chsz = (NULL != child && MDOC_TEXT == child->type) ?
-           strlen(child->string) : 0;
+       if (bl->type == LIST_enum)
+               chsz = (bl->count > 8) + 1;
+       else if (child != NULL && child->type == MDOC_TEXT)
+               chsz = strlen(child->string);
+       else
+               chsz = 0;
 
        /* Maybe we are inside an enclosing list? */
        mid_it();
@@ -502,17 +508,17 @@ print_width(const char *v, const struct mdoc_node *child, size_t defsz)
        Bl_stack[Bl_stack_len++] = sz + 2;
 
        /* Set up the current list. */
-       if (defsz && chsz > sz)
+       if (chsz > sz && bl->type != LIST_tag)
                print_block(".HP", 0);
        else {
                print_block(".TP", 0);
                remain = sz + 2;
        }
        if (numeric) {
-               (void)snprintf(buf, sizeof(buf), "%zun", sz + 2);
+               (void)snprintf(buf, sizeof(buf), "%dn", sz + 2);
                print_word(buf);
        } else
-               print_word(v);
+               print_word(bl->width);
        TPremain = remain;
 }
 
@@ -521,7 +527,7 @@ print_count(int *count)
 {
        char              buf[24];
 
-       (void)snprintf(buf, sizeof(buf), "%d.", ++*count);
+       (void)snprintf(buf, sizeof(buf), "%d.\\&", ++*count);
        print_word(buf);
 }
 
@@ -548,8 +554,9 @@ man_mdoc(void *arg, const struct mdoc *mdoc)
        n = mdoc_node(mdoc);
 
        printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
-           meta->title, meta->msec, meta->date,
-           meta->os, meta->vol);
+           meta->title,
+           (meta->msec == NULL ? "" : meta->msec),
+           meta->date, meta->os, meta->vol);
 
        /* Disable hyphenation and if nroff, disable justification. */
        printf(".nh\n.if n .ad l");
@@ -593,15 +600,19 @@ print_node(DECL_ARGS)
                        printf("\\&");
                        outflags &= ~MMAN_spc;
                }
+               if (outflags & MMAN_Sm && ! (n->flags & MDOC_DELIMC))
+                       outflags |= MMAN_spc_force;
                print_word(n->string);
+               if (outflags & MMAN_Sm && ! (n->flags & MDOC_DELIMO))
+                       outflags |= MMAN_spc;
        } else {
                /*
                 * Conditionally run the pre-node action handler for a
                 * node.
                 */
                act = manacts + n->tok;
-               cond = NULL == act->cond || (*act->cond)(meta, n);
-               if (cond && act->pre && ENDBODY_NOT == n->end)
+               cond = act->cond == NULL || (*act->cond)(meta, n);
+               if (cond && act->pre && (n->end == ENDBODY_NOT || n->nchild))
                        do_sub = (*act->pre)(meta, n);
        }
 
@@ -864,6 +875,25 @@ pre_ap(DECL_ARGS)
        return(0);
 }
 
+static int
+pre_aq(DECL_ARGS)
+{
+
+       print_word(n->parent->prev != NULL &&
+           n->parent->prev->tok == MDOC_An ?  "<" : "\\(la");
+       outflags &= ~MMAN_spc;
+       return(1);
+}
+
+static void
+post_aq(DECL_ARGS)
+{
+
+       outflags &= ~(MMAN_spc | MMAN_nl);
+       print_word(n->parent->prev != NULL &&
+           n->parent->prev->tok == MDOC_An ?  ">" : "\\(ra");
+}
+
 static int
 pre_bd(DECL_ARGS)
 {
@@ -875,7 +905,7 @@ pre_bd(DECL_ARGS)
                print_line(".nf", 0);
        if (0 == n->norm->Bd.comp && NULL != n->parent->prev)
                outflags |= MMAN_sp;
-       print_offs(n->norm->Bd.offs);
+       print_offs(n->norm->Bd.offs, 1);
        return(1);
 }
 
@@ -962,7 +992,7 @@ pre_bl(DECL_ARGS)
         * just nest and do not add up their indentation.
         */
        if (n->norm->Bl.offs) {
-               print_offs(n->norm->Bl.offs);
+               print_offs(n->norm->Bl.offs, 0);
                Bl_stack[Bl_stack_len++] = 0;
        }
 
@@ -1047,7 +1077,7 @@ static int
 pre_dl(DECL_ARGS)
 {
 
-       print_offs("6n");
+       print_offs("6n", 0);
        return(1);
 }
 
@@ -1097,19 +1127,20 @@ post_en(DECL_ARGS)
        return;
 }
 
-static void
-post_eo(DECL_ARGS)
+static int
+pre_eo(DECL_ARGS)
 {
 
-       if (MDOC_HEAD == n->type || MDOC_BODY == n->type)
-               outflags &= ~MMAN_spc;
+       outflags &= ~(MMAN_spc | MMAN_nl);
+       return(1);
 }
 
-static int
-pre_es(DECL_ARGS)
+static void
+post_eo(DECL_ARGS)
 {
 
-       return(0);
+       if (n->end != ENDBODY_SPACE)
+               outflags &= ~MMAN_spc;
 }
 
 static int
@@ -1165,7 +1196,8 @@ pre_fl(DECL_ARGS)
 
        font_push('B');
        print_word("\\-");
-       outflags &= ~MMAN_spc;
+       if (n->nchild)
+               outflags &= ~MMAN_spc;
        return(1);
 }
 
@@ -1174,8 +1206,10 @@ post_fl(DECL_ARGS)
 {
 
        font_pop();
-       if (0 == n->nchild && NULL != n->next &&
-                       n->next->line == n->line)
+       if ( ! (n->nchild ||
+           n->next == NULL ||
+           n->next->type == MDOC_TEXT ||
+           n->next->flags & MDOC_LINE))
                outflags &= ~MMAN_spc;
 }
 
@@ -1331,31 +1365,31 @@ pre_it(DECL_ARGS)
                case LIST_dash:
                        /* FALLTHROUGH */
                case LIST_hyphen:
-                       print_width(bln->norm->Bl.width, NULL, 0);
+                       print_width(&bln->norm->Bl, NULL);
                        TPremain = 0;
                        outflags |= MMAN_nl;
                        font_push('B');
                        if (LIST_bullet == bln->norm->Bl.type)
-                               print_word("o");
+                               print_word("\\(bu");
                        else
                                print_word("-");
                        font_pop();
                        outflags |= MMAN_nl;
                        return(0);
                case LIST_enum:
-                       print_width(bln->norm->Bl.width, NULL, 0);
+                       print_width(&bln->norm->Bl, NULL);
                        TPremain = 0;
                        outflags |= MMAN_nl;
                        print_count(&bln->norm->Bl.count);
                        outflags |= MMAN_nl;
                        return(0);
                case LIST_hang:
-                       print_width(bln->norm->Bl.width, n->child, 6);
+                       print_width(&bln->norm->Bl, n->child);
                        TPremain = 0;
                        outflags |= MMAN_nl;
                        return(1);
                case LIST_tag:
-                       print_width(bln->norm->Bl.width, n->child, 0);
+                       print_width(&bln->norm->Bl, n->child);
                        putchar('\n');
                        outflags &= ~MMAN_spc;
                        return(1);
@@ -1387,7 +1421,7 @@ mid_it(void)
 
        /* Restore the indentation of the enclosing list. */
        print_line(".RS", MMAN_Bk_susp);
-       (void)snprintf(buf, sizeof(buf), "%zun",
+       (void)snprintf(buf, sizeof(buf), "%dn",
            Bl_stack[Bl_stack_len - 1]);
        print_word(buf);
 
@@ -1571,7 +1605,8 @@ static void
 post_pf(DECL_ARGS)
 {
 
-       outflags &= ~MMAN_spc;
+       if ( ! (n->next == NULL || n->next->flags & MDOC_LINE))
+               outflags &= ~MMAN_spc;
 }
 
 static int
@@ -1648,6 +1683,13 @@ pre_rv(DECL_ARGS)
        return(0);
 }
 
+static int
+pre_skip(DECL_ARGS)
+{
+
+       return(0);
+}
+
 static int
 pre_sm(DECL_ARGS)
 {