]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_man.c
Rudimentary implementation of the .it request (input line trap).
[mandoc.git] / mdoc_man.c
index 960e9ea85ef6b256d415e3b6b4c940dbab858c61..7a28ea78c73aaa32cd671c7888b01da632663ece 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_man.c,v 1.44 2012/11/18 19:34:19 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.51 2013/06/02 18:16:57 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 */
@@ -251,9 +252,10 @@ static     int             outflags;
 #define        MMAN_PP         (1 << 5)  /* reset indentation etc. */
 #define        MMAN_Sm         (1 << 6)  /* horizontal spacing mode */
 #define        MMAN_Bk         (1 << 7)  /* word keep mode */
-#define        MMAN_An_split   (1 << 8)  /* author mode is "split" */
-#define        MMAN_An_nosplit (1 << 9)  /* author mode is "nosplit" */
-#define        MMAN_PD         (1 << 10) /* inter-paragraph spacing disabled */
+#define        MMAN_Bk_susp    (1 << 8)  /* suspend this (after a macro) */
+#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        BL_STACK_MAX    32
 
@@ -334,11 +336,10 @@ print_word(const char *s)
                 */
                if (MMAN_spc_force & outflags || '\0' == s[0] ||
                    NULL == strchr(".,:;)]?!", s[0]) || '\0' != s[1]) {
-                       if (MMAN_Bk & outflags) {
+                       if (MMAN_Bk & outflags &&
+                           ! (MMAN_Bk_susp & outflags))
                                putchar('\\');
-                               putchar('~');
-                       } else 
-                               putchar(' ');
+                       putchar(' ');
                        if (TPremain)
                                TPremain--;
                }
@@ -353,12 +354,12 @@ print_word(const char *s)
                outflags |= MMAN_spc;
        else
                outflags &= ~MMAN_spc;
-       outflags &= ~MMAN_spc_force;
+       outflags &= ~(MMAN_spc_force | MMAN_Bk_susp);
 
        for ( ; *s; s++) {
                switch (*s) {
                case (ASCII_NBRSP):
-                       printf("\\~");
+                       printf("\\ ");
                        break;
                case (ASCII_HYPH):
                        putchar('-');
@@ -393,13 +394,11 @@ print_block(const char *s, int newflags)
                        print_line(".PD", 0);
                        outflags &= ~MMAN_PD;
                }
-       } else if (! (MMAN_PD & outflags)) {
-               print_line(".PD 0", 0);
-               outflags |= MMAN_PD;
-       }
+       } else if (! (MMAN_PD & outflags))
+               print_line(".PD 0", MMAN_PD);
        outflags |= MMAN_nl;
        print_word(s);
-       outflags |= newflags;
+       outflags |= MMAN_Bk_susp | newflags;
 }
 
 static void
@@ -409,6 +408,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;
@@ -428,6 +429,7 @@ print_offs(const char *v)
                         * in terms of different units.
                         */
                        print_word(v);
+                       outflags |= MMAN_nl;
                        return;
                }
        } else
@@ -442,8 +444,12 @@ print_offs(const char *v)
 
        snprintf(buf, sizeof(buf), "%ldn", 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)
 {
@@ -472,16 +478,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", 0);
-               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,
@@ -535,10 +533,13 @@ man_mdoc(void *arg, const struct mdoc *mdoc)
        meta = mdoc_meta(mdoc);
        n = mdoc_node(mdoc);
 
-       printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"",
+       printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
                        meta->title, meta->msec, meta->date,
                        meta->os, meta->vol);
 
+       /* Disable hyphenation and if nroff, disable justification. */
+       printf(".nh\n.if n .ad l");
+
        outflags = MMAN_nl | MMAN_Sm;
        if (0 == fontqueue.size) {
                fontqueue.size = 8;
@@ -555,7 +556,7 @@ print_node(DECL_ARGS)
        const struct mdoc_node  *prev, *sub;
        const struct manact     *act;
        int                      cond, do_sub;
-       
+
        /*
         * Break the line if we were parsed subsequent the current node.
         * This makes the page structure be more consistent.
@@ -705,13 +706,25 @@ static int
 pre_sect(DECL_ARGS)
 {
 
-       if (MDOC_HEAD != n->type)
-               return(1);
-       outflags |= MMAN_sp;
-       print_block(manacts[n->tok].prefix, 0);
-       print_word("");
-       putchar('\"');
-       outflags &= ~MMAN_spc;
+       switch (n->type) {
+       case (MDOC_HEAD):
+               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);
 }
 
@@ -816,16 +829,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", 0);
        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);
@@ -833,20 +843,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", 0);
-               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
@@ -902,7 +901,7 @@ static void
 post_bk(DECL_ARGS)
 {
 
-       if (MDOC_BODY == n->type)
+       if (MDOC_BODY == n->type && ! (MDOC_SYNPRETTY & n->flags))
                outflags &= ~MMAN_Bk;
 }
 
@@ -911,6 +910,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;
@@ -943,8 +952,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
@@ -979,7 +1001,7 @@ static int
 pre_dl(DECL_ARGS)
 {
 
-       print_line(".RS 6n", MMAN_nl);
+       print_offs("6n");
        return(1);
 }
 
@@ -988,6 +1010,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
@@ -1053,7 +1079,7 @@ pre_fl(DECL_ARGS)
 {
 
        font_push('B');
-       print_word("-");
+       print_word("\\-");
        outflags &= ~MMAN_spc;
        return(1);
 }
@@ -1250,6 +1276,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), "%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;
+}
+
 static void
 post_it(DECL_ARGS)
 {
@@ -1289,20 +1341,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) {
@@ -1531,7 +1576,7 @@ pre_ux(DECL_ARGS)
        if (NULL == n->child)
                return(0);
        outflags &= ~MMAN_spc;
-       print_word("\\~");
+       print_word("\\ ");
        outflags &= ~MMAN_spc;
        return(1);
 }