]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_man.c
To better support MLINKS, we will have to split the "docs" database
[mandoc.git] / mdoc_man.c
index acf4f16c869545c763ac8093793ea0d06d621369..6ee8b3abf45e5781857c765acae3a3261359f3e7 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_man.c,v 1.46 2012/11/19 02:14:45 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.57 2013/12/25 22:00:45 schwarze Exp $ */
 /*
- * Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011, 2012, 2013 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
@@ -43,6 +43,7 @@ static        int       cond_body(DECL_ARGS);
 static int       cond_head(DECL_ARGS);
 static  void     font_push(char);
 static void      font_pop(void);
+static void      mid_it(void);
 static void      post__t(DECL_ARGS);
 static void      post_bd(DECL_ARGS);
 static void      post_bf(DECL_ARGS);
@@ -181,8 +182,8 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, pre_bx, NULL, NULL, NULL }, /* Bx */
        { NULL, NULL, NULL, NULL, NULL }, /* Db */
        { NULL, NULL, NULL, NULL, NULL }, /* Dc */
-       { cond_body, pre_enc, post_enc, "``", "''" }, /* Do */
-       { cond_body, pre_enc, post_enc, "``", "''" }, /* Dq */
+       { 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 */
@@ -198,14 +199,14 @@ static    const struct manact manacts[MDOC_MAX + 1] = {
        { cond_body, pre_enc, post_enc, "(", ")" }, /* Po */
        { cond_body, pre_enc, post_enc, "(", ")" }, /* Pq */
        { NULL, NULL, NULL, NULL, NULL }, /* Qc */
-       { cond_body, pre_enc, post_enc, "`", "'" }, /* Ql */
+       { cond_body, pre_enc, post_enc, "\\(oq", "\\(cq" }, /* Ql */
        { cond_body, pre_enc, post_enc, "\"", "\"" }, /* Qo */
        { cond_body, pre_enc, post_enc, "\"", "\"" }, /* Qq */
        { NULL, NULL, NULL, NULL, NULL }, /* Re */
        { cond_body, pre_rs, NULL, NULL, NULL }, /* Rs */
        { NULL, NULL, NULL, NULL, NULL }, /* Sc */
-       { cond_body, pre_enc, post_enc, "`", "'" }, /* So */
-       { cond_body, pre_enc, post_enc, "`", "'" }, /* Sq */
+       { cond_body, pre_enc, post_enc, "\\(oq", "\\(cq" }, /* So */
+       { cond_body, pre_enc, post_enc, "\\(oq", "\\(cq" }, /* Sq */
        { NULL, pre_sm, NULL, NULL, NULL }, /* Sm */
        { NULL, pre_em, post_font, NULL, NULL }, /* Sx */
        { NULL, pre_sy, post_font, NULL, NULL }, /* Sy */
@@ -255,6 +256,7 @@ static      int             outflags;
 #define        MMAN_An_split   (1 << 9)  /* author mode is "split" */
 #define        MMAN_An_nosplit (1 << 10) /* author mode is "nosplit" */
 #define        MMAN_PD         (1 << 11) /* inter-paragraph spacing disabled */
+#define        MMAN_nbrword    (1 << 12) /* do not break the next word */
 
 #define        BL_STACK_MAX    32
 
@@ -363,6 +365,12 @@ print_word(const char *s)
                case (ASCII_HYPH):
                        putchar('-');
                        break;
+               case (' '):
+                       if (MMAN_nbrword & outflags) {
+                               printf("\\ ");
+                               break;
+                       }
+                       /* FALLTHROUGH */
                default:
                        putchar((unsigned char)*s);
                        break;
@@ -370,6 +378,7 @@ print_word(const char *s)
                if (TPremain)
                        TPremain--;
        }
+       outflags &= ~MMAN_nbrword;
 }
 
 static void
@@ -407,6 +416,8 @@ print_offs(const char *v)
        struct roffsu     su;
        size_t            sz;
 
+       print_line(".RS", MMAN_Bk_susp);
+
        /* Convert v into a number (of characters). */
        if (NULL == v || '\0' == *v || 0 == strcmp(v, "left"))
                sz = 0;
@@ -426,6 +437,7 @@ print_offs(const char *v)
                         * in terms of different units.
                         */
                        print_word(v);
+                       outflags |= MMAN_nl;
                        return;
                }
        } else
@@ -438,10 +450,14 @@ print_offs(const char *v)
        if (Bl_stack_len)
                sz += Bl_stack[Bl_stack_len - 1];
 
-       snprintf(buf, sizeof(buf), "%ldn", sz);
+       snprintf(buf, sizeof(buf), "%zun", sz);
        print_word(buf);
+       outflags |= MMAN_nl;
 }
 
+/*
+ * Set up the indentation for a list item; used from pre_it().
+ */
 void
 print_width(const char *v, const struct mdoc_node *child, size_t defsz)
 {
@@ -470,16 +486,8 @@ print_width(const char *v, const struct mdoc_node *child, size_t defsz)
        chsz = (NULL != child && MDOC_TEXT == child->type) ?
                        strlen(child->string) : 0;
 
-       /*
-        * If we are inside an enclosing list,
-        * preserve its indentation.
-        */
-       if (Bl_stack_len && Bl_stack[Bl_stack_len - 1]) {
-               print_line(".RS", MMAN_Bk_susp);
-               snprintf(buf, sizeof(buf), "%ldn",
-                               Bl_stack[Bl_stack_len - 1]);
-               print_word(buf);
-       }
+       /* Maybe we are inside an enclosing list? */
+       mid_it();
 
        /*
         * Save our own indentation,
@@ -495,7 +503,7 @@ print_width(const char *v, const struct mdoc_node *child, size_t defsz)
                remain = sz + 2;
        }
        if (numeric) {
-               snprintf(buf, sizeof(buf), "%ldn", sz + 2);
+               snprintf(buf, sizeof(buf), "%zun", sz + 2);
                print_word(buf);
        } else
                print_word(v);
@@ -553,7 +561,7 @@ man_mdoc(void *arg, const struct mdoc *mdoc)
 static void
 print_node(DECL_ARGS)
 {
-       const struct mdoc_node  *prev, *sub;
+       const struct mdoc_node  *sub;
        const struct manact     *act;
        int                      cond, do_sub;
 
@@ -561,8 +569,7 @@ print_node(DECL_ARGS)
         * Break the line if we were parsed subsequent the current node.
         * This makes the page structure be more consistent.
         */
-       prev = n->prev ? n->prev : n->parent;
-       if (MMAN_spc & outflags && prev && prev->line < n->line)
+       if (MMAN_spc & outflags && MDOC_LINE & n->flags)
                outflags |= MMAN_nl;
 
        act = NULL;
@@ -706,24 +713,12 @@ static int
 pre_sect(DECL_ARGS)
 {
 
-       switch (n->type) {
-       case (MDOC_HEAD):
+       if (MDOC_HEAD == n->type) {
                outflags |= MMAN_sp;
                print_block(manacts[n->tok].prefix, 0);
                print_word("");
                putchar('\"');
                outflags &= ~MMAN_spc;
-               break;
-       case (MDOC_BODY):
-               if (MDOC_Sh == n->tok) {
-                       if (MDOC_SYNPRETTY & n->flags)
-                               outflags |= MMAN_Bk;
-                       else
-                               outflags &= ~MMAN_Bk;
-               }
-               break;
-       default:
-               break;
        }
        return(1);
 }
@@ -829,16 +824,13 @@ pre_bd(DECL_ARGS)
                print_line(".nf", 0);
        if (0 == n->norm->Bd.comp && NULL != n->parent->prev)
                outflags |= MMAN_sp;
-       print_line(".RS", MMAN_Bk_susp);
        print_offs(n->norm->Bd.offs);
-       outflags |= MMAN_nl;
        return(1);
 }
 
 static void
 post_bd(DECL_ARGS)
 {
-       char             buf[24];
 
        /* Close out this display. */
        print_line(".RE", MMAN_nl);
@@ -846,20 +838,9 @@ post_bd(DECL_ARGS)
            DISP_literal  == n->norm->Bd.type)
                print_line(".fi", MMAN_nl);
 
-       /*
-        * If we are inside an enclosing list and the current
-        * list item is not yet finished, restore the correct
-        * indentation for what remains of that item.
-        */
-       if (NULL != n->parent->next &&
-           Bl_stack_len && Bl_stack[Bl_stack_len - 1]) {
-               print_line(".RS", MMAN_Bk_susp);
-               snprintf(buf, sizeof(buf), "%ldn",
-                               Bl_stack[Bl_stack_len - 1]);
-               print_word(buf);
-               /* Remeber to close out this .RS block later. */
-               Bl_stack_post[Bl_stack_len - 1] = 1;
-       }
+       /* Maybe we are inside an enclosing list? */
+       if (NULL != n->parent->next)
+               mid_it();
 }
 
 static int
@@ -924,6 +905,16 @@ pre_bl(DECL_ARGS)
 {
        size_t           icol;
 
+       /*
+        * print_offs() will increase the -offset to account for
+        * a possible enclosing .It, but any enclosed .It blocks
+        * just nest and do not add up their indentation.
+        */
+       if (n->norm->Bl.offs) {
+               print_offs(n->norm->Bl.offs);
+               Bl_stack[Bl_stack_len++] = 0;
+       }
+
        switch (n->norm->Bl.type) {
        case (LIST_enum):
                n->norm->Bl.count = 0;
@@ -956,8 +947,21 @@ post_bl(DECL_ARGS)
        default:
                break;
        }
-       outflags |= MMAN_PP | MMAN_nl;
-       outflags &= ~(MMAN_sp | MMAN_br);
+
+       if (n->norm->Bl.offs) {
+               print_line(".RE", MMAN_nl);
+               assert(Bl_stack_len);
+               Bl_stack_len--;
+               assert(0 == Bl_stack[Bl_stack_len]);
+       } else {
+               outflags |= MMAN_PP | MMAN_nl;
+               outflags &= ~(MMAN_sp | MMAN_br);
+       }
+
+       /* Maybe we are inside an enclosing list? */
+       if (NULL != n->parent->next)
+               mid_it();
+
 }
 
 static int
@@ -992,7 +996,7 @@ static int
 pre_dl(DECL_ARGS)
 {
 
-       print_line(".RS 6n", MMAN_nl);
+       print_offs("6n");
        return(1);
 }
 
@@ -1001,6 +1005,10 @@ post_dl(DECL_ARGS)
 {
 
        print_line(".RE", MMAN_nl);
+
+       /* Maybe we are inside an enclosing list? */
+       if (NULL != n->parent->next)
+               mid_it();
 }
 
 static int
@@ -1022,12 +1030,17 @@ post_eo(DECL_ARGS)
 static int
 pre_fa(DECL_ARGS)
 {
+       int      am_Fa;
 
-       if (MDOC_Fa == n->tok)
+       am_Fa = MDOC_Fa == n->tok;
+
+       if (am_Fa)
                n = n->child;
 
        while (NULL != n) {
                font_push('I');
+               if (am_Fa || MDOC_SYNPRETTY & n->flags)
+                       outflags |= MMAN_nbrword;
                print_node(meta, n);
                font_pop();
                if (NULL != (n = n->next))
@@ -1091,6 +1104,9 @@ pre_fn(DECL_ARGS)
        if (NULL == n)
                return(0);
 
+       if (MDOC_SYNPRETTY & n->flags)
+               print_block(".HP 4n", MMAN_nl);
+
        font_push('B');
        print_node(meta, n);
        font_pop();
@@ -1111,7 +1127,7 @@ post_fn(DECL_ARGS)
        print_word(")");
        if (MDOC_SYNPRETTY & n->flags) {
                print_word(";");
-               outflags |= MMAN_br;
+               outflags |= MMAN_PP;
        }
 }
 
@@ -1124,6 +1140,8 @@ pre_fo(DECL_ARGS)
                pre_syn(n);
                break;
        case (MDOC_HEAD):
+               if (MDOC_SYNPRETTY & n->flags)
+                       print_block(".HP 4n", MMAN_nl);
                font_push('B');
                break;
        case (MDOC_BODY):
@@ -1136,7 +1154,7 @@ pre_fo(DECL_ARGS)
        }
        return(1);
 }
-               
+
 static void
 post_fo(DECL_ARGS)
 {
@@ -1263,6 +1281,32 @@ pre_it(DECL_ARGS)
        return(1);
 }
 
+/*
+ * This function is called after closing out an indented block.
+ * If we are inside an enclosing list, restore its indentation.
+ */
+static void
+mid_it(void)
+{
+       char             buf[24];
+
+       /* Nothing to do outside a list. */
+       if (0 == Bl_stack_len || 0 == Bl_stack[Bl_stack_len - 1])
+               return;
+
+       /* The indentation has already been set up. */
+       if (Bl_stack_post[Bl_stack_len - 1])
+               return;
+
+       /* Restore the indentation of the enclosing list. */
+       print_line(".RS", MMAN_Bk_susp);
+       snprintf(buf, sizeof(buf), "%zun", Bl_stack[Bl_stack_len - 1]);
+       print_word(buf);
+
+       /* Remeber to close out this .RS block later. */
+       Bl_stack_post[Bl_stack_len - 1] = 1;
+}
+
 static void
 post_it(DECL_ARGS)
 {
@@ -1302,20 +1346,13 @@ post_it(DECL_ARGS)
 
                        /*
                         * Our indentation had to be restored
-                        * after a child display.
+                        * after a child display or child list.
                         * Close out that indentation block now.
                         */
                        if (Bl_stack_post[Bl_stack_len]) {
                                print_line(".RE", MMAN_nl);
                                Bl_stack_post[Bl_stack_len] = 0;
                        }
-
-                       /*
-                        * We are inside an enclosing list.
-                        * Restore the indentation of that list.
-                        */
-                       if (Bl_stack_len && Bl_stack[Bl_stack_len - 1])
-                               print_line(".RE", MMAN_nl);
                        break;
                case (LIST_column):
                        if (NULL != n->next) {
@@ -1377,8 +1414,10 @@ pre_nm(DECL_ARGS)
 {
        char    *name;
 
-       if (MDOC_BLOCK == n->type)
+       if (MDOC_BLOCK == n->type) {
+               outflags |= MMAN_Bk;
                pre_syn(n);
+       }
        if (MDOC_ELEM != n->type && MDOC_HEAD != n->type)
                return(1);
        name = n->child ? n->child->string : meta->name;
@@ -1388,7 +1427,7 @@ pre_nm(DECL_ARGS)
                if (NULL == n->parent->prev)
                        outflags |= MMAN_sp;
                print_block(".HP", 0);
-               printf(" %ldn", strlen(name) + 1);
+               printf(" %zun", strlen(name) + 1);
                outflags |= MMAN_nl;
        }
        font_push('B');
@@ -1401,9 +1440,18 @@ static void
 post_nm(DECL_ARGS)
 {
 
-       if (MDOC_ELEM != n->type && MDOC_HEAD != n->type)
-               return;
-       font_pop();
+       switch (n->type) {
+       case (MDOC_BLOCK):
+               outflags &= ~MMAN_Bk;
+               break;
+       case (MDOC_HEAD):
+               /* FALLTHROUGH */
+       case (MDOC_ELEM):
+               font_pop();
+               break;
+       default:
+               break;
+       }
 }
 
 static int