]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_man.c
Implement the obsolete macros .En .Es .Fr .Ot for backward compatibility,
[mandoc.git] / mdoc_man.c
index 6ee8b3abf45e5781857c765acae3a3261359f3e7..8dcfae743772c9d6082d90124c32d3e164f1ede6 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_man.c,v 1.57 2013/12/25 22:00:45 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.64 2014/07/02 03:48:07 schwarze Exp $ */
 /*
- * Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011, 2012, 2013, 2014 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
@@ -23,6 +23,7 @@
 #include <string.h>
 
 #include "mandoc.h"
+#include "mandoc_aux.h"
 #include "out.h"
 #include "man.h"
 #include "mdoc.h"
@@ -50,6 +51,7 @@ static        void      post_bf(DECL_ARGS);
 static void      post_bk(DECL_ARGS);
 static void      post_bl(DECL_ARGS);
 static void      post_dl(DECL_ARGS);
+static void      post_en(DECL_ARGS);
 static void      post_enc(DECL_ARGS);
 static void      post_eo(DECL_ARGS);
 static void      post_fa(DECL_ARGS);
@@ -77,8 +79,10 @@ static       int       pre_bl(DECL_ARGS);
 static int       pre_br(DECL_ARGS);
 static int       pre_bx(DECL_ARGS);
 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_fa(DECL_ARGS);
 static int       pre_fd(DECL_ARGS);
 static int       pre_fl(DECL_ARGS);
@@ -89,6 +93,7 @@ static        int       pre_in(DECL_ARGS);
 static int       pre_it(DECL_ARGS);
 static int       pre_lk(DECL_ARGS);
 static int       pre_li(DECL_ARGS);
+static int       pre_ll(DECL_ARGS);
 static int       pre_nm(DECL_ARGS);
 static int       pre_no(DECL_ARGS);
 static int       pre_ns(DECL_ARGS);
@@ -148,7 +153,7 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { cond_head, pre_enc, NULL, "\\- ", NULL }, /* Nd */
        { NULL, pre_nm, post_nm, NULL, NULL }, /* Nm */
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Op */
-       { NULL, NULL, NULL, NULL, NULL }, /* Ot */
+       { NULL, pre_ft, post_font, NULL, NULL }, /* Ot */
        { NULL, pre_em, post_font, NULL, NULL }, /* Pa */
        { NULL, pre_enc, post_enc, "The \\fB",
                "\\fP\nfunction returns the value 0 if successful;\n"
@@ -222,7 +227,7 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, NULL, NULL, NULL, NULL }, /* Ek */
        { NULL, pre_ux, NULL, "is currently in beta test.", NULL }, /* Bt */
        { NULL, NULL, NULL, NULL, NULL }, /* Hf */
-       { NULL, NULL, NULL, NULL, NULL }, /* Fr */
+       { NULL, pre_em, post_font, NULL, NULL }, /* Fr */
        { NULL, pre_ux, NULL, "currently under development.", NULL }, /* Ud */
        { NULL, NULL, post_lb, NULL, NULL }, /* Lb */
        { NULL, pre_pp, NULL, NULL, NULL }, /* Lp */
@@ -232,14 +237,15 @@ 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, NULL, NULL, NULL, NULL }, /* Es */
-       { NULL, NULL, NULL, NULL, NULL }, /* En */
+       { NULL, pre_es, 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 */
        { NULL, pre_br, NULL, NULL, NULL }, /* br */
        { NULL, pre_sp, post_sp, NULL, NULL }, /* sp */
        { NULL, NULL, post_percent, NULL, NULL }, /* %U */
        { NULL, NULL, NULL, NULL, NULL }, /* Ta */
+       { NULL, pre_ll, post_sp, NULL, NULL }, /* ll */
        { NULL, NULL, NULL, NULL, NULL }, /* ROOT */
 };
 
@@ -271,6 +277,7 @@ static      struct {
        size_t   size;
 }      fontqueue;
 
+
 static void
 font_push(char newfont)
 {
@@ -278,7 +285,7 @@ font_push(char newfont)
        if (fontqueue.head + fontqueue.size <= ++fontqueue.tail) {
                fontqueue.size += 8;
                fontqueue.head = mandoc_realloc(fontqueue.head,
-                               fontqueue.size);
+                   fontqueue.size);
        }
        *fontqueue.tail = newfont;
        print_word("");
@@ -304,7 +311,7 @@ print_word(const char *s)
 {
 
        if ((MMAN_PP | MMAN_sp | MMAN_br | MMAN_nl) & outflags) {
-               /* 
+               /*
                 * If we need a newline, print it now and start afresh.
                 */
                if (MMAN_PP & outflags) {
@@ -359,13 +366,16 @@ print_word(const char *s)
 
        for ( ; *s; s++) {
                switch (*s) {
-               case (ASCII_NBRSP):
+               case ASCII_NBRSP:
                        printf("\\ ");
                        break;
-               case (ASCII_HYPH):
+               case ASCII_HYPH:
                        putchar('-');
                        break;
-               case (' '):
+               case ASCII_BREAK:
+                       printf("\\:");
+                       break;
+               case ' ':
                        if (MMAN_nbrword & outflags) {
                                printf("\\ ");
                                break;
@@ -450,7 +460,7 @@ print_offs(const char *v)
        if (Bl_stack_len)
                sz += Bl_stack[Bl_stack_len - 1];
 
-       snprintf(buf, sizeof(buf), "%zun", sz);
+       (void)snprintf(buf, sizeof(buf), "%zun", sz);
        print_word(buf);
        outflags |= MMAN_nl;
 }
@@ -458,7 +468,7 @@ print_offs(const char *v)
 /*
  * Set up the indentation for a list item; used from pre_it().
  */
-void
+static void
 print_width(const char *v, const struct mdoc_node *child, size_t defsz)
 {
        char              buf[24];
@@ -484,7 +494,7 @@ print_width(const char *v, const struct mdoc_node *child, size_t defsz)
 
        /* XXX Rough estimation, might have multiple parts. */
        chsz = (NULL != child && MDOC_TEXT == child->type) ?
-                       strlen(child->string) : 0;
+           strlen(child->string) : 0;
 
        /* Maybe we are inside an enclosing list? */
        mid_it();
@@ -503,19 +513,19 @@ print_width(const char *v, const struct mdoc_node *child, size_t defsz)
                remain = sz + 2;
        }
        if (numeric) {
-               snprintf(buf, sizeof(buf), "%zun", sz + 2);
+               (void)snprintf(buf, sizeof(buf), "%zun", sz + 2);
                print_word(buf);
        } else
                print_word(v);
        TPremain = remain;
 }
 
-void
+static void
 print_count(int *count)
 {
-       char              buf[12];
+       char              buf[24];
 
-       snprintf(buf, sizeof(buf), "%d.", ++*count);
+       (void)snprintf(buf, sizeof(buf), "%d.", ++*count);
        print_word(buf);
 }
 
@@ -542,8 +552,8 @@ 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, meta->date,
+           meta->os, meta->vol);
 
        /* Disable hyphenation and if nroff, disable justification. */
        printf(".nh\n.if n .ad l");
@@ -581,8 +591,8 @@ print_node(DECL_ARGS)
                 * Make sure that we don't happen to start with a
                 * control character at the start of a line.
                 */
-               if (MMAN_nl & outflags && ('.' == *n->string || 
-                                       '\'' == *n->string)) {
+               if (MMAN_nl & outflags &&
+                   ('.' == *n->string || '\'' == *n->string)) {
                        print_word("");
                        printf("\\&");
                        outflags &= ~MMAN_spc;
@@ -595,11 +605,11 @@ print_node(DECL_ARGS)
                 */
                act = manacts + n->tok;
                cond = NULL == act->cond || (*act->cond)(meta, n);
-               if (cond && act->pre)
+               if (cond && act->pre && ENDBODY_NOT == n->end)
                        do_sub = (*act->pre)(meta, n);
        }
 
-       /* 
+       /*
         * Conditionally run all child nodes.
         * Note that this iterates over children instead of using
         * recursion.  This prevents unnecessary depth in the stack.
@@ -611,8 +621,17 @@ print_node(DECL_ARGS)
        /*
         * Lastly, conditionally run the post-node handler.
         */
+       if (MDOC_ENDED & n->flags)
+               return;
+
        if (cond && act->post)
                (*act->post)(meta, n);
+
+       if (ENDBODY_NOT != n->end)
+               n->pending->flags |= MDOC_ENDED;
+
+       if (ENDBODY_NOSPACE == n->end)
+               outflags &= ~(MMAN_spc | MMAN_nl);
 }
 
 static int
@@ -650,7 +669,7 @@ post_enc(DECL_ARGS)
        suffix = manacts[n->tok].suffix;
        if (NULL == suffix)
                return;
-       outflags &= ~MMAN_spc;
+       outflags &= ~(MMAN_spc | MMAN_nl);
        print_word(suffix);
 }
 
@@ -682,8 +701,8 @@ static int
 pre__t(DECL_ARGS)
 {
 
-        if (n->parent && MDOC_Rs == n->parent->tok &&
-                        n->parent->norm->Rs.quote_T) {
+       if (n->parent && MDOC_Rs == n->parent->tok &&
+           n->parent->norm->Rs.quote_T) {
                print_word("");
                putchar('\"');
                outflags &= ~MMAN_spc;
@@ -696,8 +715,8 @@ static void
 post__t(DECL_ARGS)
 {
 
-        if (n->parent && MDOC_Rs == n->parent->tok &&
-                        n->parent->norm->Rs.quote_T) {
+       if (n->parent && MDOC_Rs == n->parent->tok &&
+           n->parent->norm->Rs.quote_T) {
                outflags &= ~MMAN_spc;
                print_word("");
                putchar('\"');
@@ -749,26 +768,26 @@ pre_syn(const struct mdoc_node *n)
                return;
 
        if (n->prev->tok == n->tok &&
-                       MDOC_Ft != n->tok &&
-                       MDOC_Fo != n->tok &&
-                       MDOC_Fn != n->tok) {
+           MDOC_Ft != n->tok &&
+           MDOC_Fo != n->tok &&
+           MDOC_Fn != n->tok) {
                outflags |= MMAN_br;
                return;
        }
 
        switch (n->prev->tok) {
-       case (MDOC_Fd):
+       case MDOC_Fd:
                /* FALLTHROUGH */
-       case (MDOC_Fn):
+       case MDOC_Fn:
                /* FALLTHROUGH */
-       case (MDOC_Fo):
+       case MDOC_Fo:
                /* FALLTHROUGH */
-       case (MDOC_In):
+       case MDOC_In:
                /* FALLTHROUGH */
-       case (MDOC_Vt):
+       case MDOC_Vt:
                outflags |= MMAN_sp;
                break;
-       case (MDOC_Ft):
+       case MDOC_Ft:
                if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
                        outflags |= MMAN_sp;
                        break;
@@ -785,11 +804,11 @@ pre_an(DECL_ARGS)
 {
 
        switch (n->norm->An.auth) {
-       case (AUTH_split):
+       case AUTH_split:
                outflags &= ~MMAN_An_nosplit;
                outflags |= MMAN_An_split;
                return(0);
-       case (AUTH_nosplit):
+       case AUTH_nosplit:
                outflags &= ~MMAN_An_split;
                outflags |= MMAN_An_nosplit;
                return(0);
@@ -848,18 +867,18 @@ pre_bf(DECL_ARGS)
 {
 
        switch (n->type) {
-       case (MDOC_BLOCK):
+       case MDOC_BLOCK:
                return(1);
-       case (MDOC_BODY):
+       case MDOC_BODY:
                break;
        default:
                return(0);
        }
        switch (n->norm->Bf.font) {
-       case (FONT_Em):
+       case FONT_Em:
                font_push('I');
                break;
-       case (FONT_Sy):
+       case FONT_Sy:
                font_push('B');
                break;
        default:
@@ -882,9 +901,9 @@ pre_bk(DECL_ARGS)
 {
 
        switch (n->type) {
-       case (MDOC_BLOCK):
+       case MDOC_BLOCK:
                return(1);
-       case (MDOC_BODY):
+       case MDOC_BODY:
                outflags |= MMAN_Bk;
                return(1);
        default:
@@ -916,10 +935,10 @@ pre_bl(DECL_ARGS)
        }
 
        switch (n->norm->Bl.type) {
-       case (LIST_enum):
+       case LIST_enum:
                n->norm->Bl.count = 0;
                return(1);
-       case (LIST_column):
+       case LIST_column:
                break;
        default:
                return(1);
@@ -938,10 +957,10 @@ post_bl(DECL_ARGS)
 {
 
        switch (n->norm->Bl.type) {
-       case (LIST_column):
+       case LIST_column:
                print_line(".TE", 0);
                break;
-       case (LIST_enum):
+       case LIST_enum:
                n->norm->Bl.count = 0;
                break;
        default:
@@ -1019,6 +1038,33 @@ pre_em(DECL_ARGS)
        return(1);
 }
 
+static int
+pre_en(DECL_ARGS)
+{
+
+       if (NULL == n->norm->Es ||
+           NULL == n->norm->Es->child)
+               return(1);
+
+       print_word(n->norm->Es->child->string);
+       outflags &= ~MMAN_spc;
+       return(1);
+}
+
+static void
+post_en(DECL_ARGS)
+{
+
+       if (NULL == n->norm->Es ||
+           NULL == n->norm->Es->child ||
+           NULL == n->norm->Es->child->next)
+               return;
+
+       outflags &= ~MMAN_spc;
+       print_word(n->norm->Es->child->next->string);
+       return;
+}
+
 static void
 post_eo(DECL_ARGS)
 {
@@ -1027,6 +1073,13 @@ post_eo(DECL_ARGS)
                outflags &= ~MMAN_spc;
 }
 
+static int
+pre_es(DECL_ARGS)
+{
+
+       return(0);
+}
+
 static int
 pre_fa(DECL_ARGS)
 {
@@ -1136,15 +1189,15 @@ pre_fo(DECL_ARGS)
 {
 
        switch (n->type) {
-       case (MDOC_BLOCK):
+       case MDOC_BLOCK:
                pre_syn(n);
                break;
-       case (MDOC_HEAD):
+       case MDOC_HEAD:
                if (MDOC_SYNPRETTY & n->flags)
                        print_block(".HP 4n", MMAN_nl);
                font_push('B');
                break;
-       case (MDOC_BODY):
+       case MDOC_BODY:
                outflags &= ~MMAN_spc;
                print_word("(");
                outflags &= ~MMAN_spc;
@@ -1160,10 +1213,10 @@ post_fo(DECL_ARGS)
 {
 
        switch (n->type) {
-       case (MDOC_HEAD):
+       case MDOC_HEAD:
                font_pop();
                break;
-       case (MDOC_BODY):
+       case MDOC_BODY:
                post_fn(meta, n);
                break;
        default:
@@ -1219,7 +1272,7 @@ pre_it(DECL_ARGS)
        const struct mdoc_node *bln;
 
        switch (n->type) {
-       case (MDOC_HEAD):
+       case MDOC_HEAD:
                outflags |= MMAN_PP | MMAN_nl;
                bln = n->parent->parent;
                if (0 == bln->norm->Bl.comp ||
@@ -1228,24 +1281,24 @@ pre_it(DECL_ARGS)
                        outflags |= MMAN_sp;
                outflags &= ~MMAN_br;
                switch (bln->norm->Bl.type) {
-               case (LIST_item):
+               case LIST_item:
                        return(0);
-               case (LIST_inset):
+               case LIST_inset:
                        /* FALLTHROUGH */
-               case (LIST_diag):
+               case LIST_diag:
                        /* FALLTHROUGH */
-               case (LIST_ohang):
+               case LIST_ohang:
                        if (bln->norm->Bl.type == LIST_diag)
                                print_line(".B \"", 0);
                        else
                                print_line(".R \"", 0);
                        outflags &= ~MMAN_spc;
                        return(1);
-               case (LIST_bullet):
+               case LIST_bullet:
                        /* FALLTHROUGH */
-               case (LIST_dash):
+               case LIST_dash:
                        /* FALLTHROUGH */
-               case (LIST_hyphen):
+               case LIST_hyphen:
                        print_width(bln->norm->Bl.width, NULL, 0);
                        TPremain = 0;
                        outflags |= MMAN_nl;
@@ -1256,17 +1309,17 @@ pre_it(DECL_ARGS)
                                print_word("-");
                        font_pop();
                        break;
-               case (LIST_enum):
+               case LIST_enum:
                        print_width(bln->norm->Bl.width, NULL, 0);
                        TPremain = 0;
                        outflags |= MMAN_nl;
                        print_count(&bln->norm->Bl.count);
                        break;
-               case (LIST_hang):
+               case LIST_hang:
                        print_width(bln->norm->Bl.width, n->child, 6);
                        TPremain = 0;
                        break;
-               case (LIST_tag):
+               case LIST_tag:
                        print_width(bln->norm->Bl.width, n->child, 0);
                        putchar('\n');
                        outflags &= ~MMAN_spc;
@@ -1300,7 +1353,8 @@ mid_it(void)
 
        /* Restore the indentation of the enclosing list. */
        print_line(".RS", MMAN_Bk_susp);
-       snprintf(buf, sizeof(buf), "%zun", Bl_stack[Bl_stack_len - 1]);
+       (void)snprintf(buf, sizeof(buf), "%zun",
+           Bl_stack[Bl_stack_len - 1]);
        print_word(buf);
 
        /* Remeber to close out this .RS block later. */
@@ -1315,32 +1369,32 @@ post_it(DECL_ARGS)
        bln = n->parent->parent;
 
        switch (n->type) {
-       case (MDOC_HEAD):
+       case MDOC_HEAD:
                switch (bln->norm->Bl.type) {
-               case (LIST_diag):
+               case LIST_diag:
                        outflags &= ~MMAN_spc;
                        print_word("\\ ");
                        break;
-               case (LIST_ohang):
+               case LIST_ohang:
                        outflags |= MMAN_br;
                        break;
                default:
                        break;
                }
                break;
-       case (MDOC_BODY):
+       case MDOC_BODY:
                switch (bln->norm->Bl.type) {
-               case (LIST_bullet):
+               case LIST_bullet:
                        /* FALLTHROUGH */
-               case (LIST_dash):
+               case LIST_dash:
                        /* FALLTHROUGH */
-               case (LIST_hyphen):
+               case LIST_hyphen:
                        /* FALLTHROUGH */
-               case (LIST_enum):
+               case LIST_enum:
                        /* FALLTHROUGH */
-               case (LIST_hang):
+               case LIST_hang:
                        /* FALLTHROUGH */
-               case (LIST_tag):
+               case LIST_tag:
                        assert(Bl_stack_len);
                        Bl_stack[--Bl_stack_len] = 0;
 
@@ -1354,7 +1408,7 @@ post_it(DECL_ARGS)
                                Bl_stack_post[Bl_stack_len] = 0;
                        }
                        break;
-               case (LIST_column):
+               case LIST_column:
                        if (NULL != n->next) {
                                putchar('\t');
                                outflags &= ~MMAN_spc;
@@ -1401,6 +1455,14 @@ pre_lk(DECL_ARGS)
        return(0);
 }
 
+static int
+pre_ll(DECL_ARGS)
+{
+
+       print_line(".ll", 0);
+       return(1);
+}
+
 static int
 pre_li(DECL_ARGS)
 {
@@ -1441,12 +1503,12 @@ post_nm(DECL_ARGS)
 {
 
        switch (n->type) {
-       case (MDOC_BLOCK):
+       case MDOC_BLOCK:
                outflags &= ~MMAN_Bk;
                break;
-       case (MDOC_HEAD):
+       case MDOC_HEAD:
                /* FALLTHROUGH */
-       case (MDOC_ELEM):
+       case MDOC_ELEM:
                font_pop();
                break;
        default:
@@ -1544,10 +1606,10 @@ pre_vt(DECL_ARGS)
 
        if (MDOC_SYNPRETTY & n->flags) {
                switch (n->type) {
-               case (MDOC_BLOCK):
+               case MDOC_BLOCK:
                        pre_syn(n);
                        return(1);
-               case (MDOC_BODY):
+               case MDOC_BODY:
                        break;
                default:
                        return(0);