]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_term.c
Fixed STRUCTURE repeat (schwarze@openbsd.org).
[mandoc.git] / man_term.c
index d5d95edc94530856da3d95b2c139b3efee2660fa..8b1c623696b473d4824176691f6b03b772055ca9 100644 (file)
@@ -1,20 +1,18 @@
-/* $Id: man_term.c,v 1.1 2009/03/26 14:38:11 kristaps Exp $ */
+/*     $Id: man_term.c,v 1.16 2009/06/18 20:46:19 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
  * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 #include <assert.h>
 #include <err.h>
 #include "term.h"
 #include "man.h"
 
+#ifdef __linux__
+extern size_t            strlcpy(char *, const char *, size_t);
+extern size_t            strlcat(char *, const char *, size_t);
+#endif
+
 #define        DECL_ARGS         struct termp *p, \
                          const struct man_node *n, \
                          const struct man_meta *m
@@ -35,8 +38,16 @@ struct       termact {
 };
 
 static int               pre_B(DECL_ARGS);
+static int               pre_BI(DECL_ARGS);
+static int               pre_BR(DECL_ARGS);
+static int               pre_br(DECL_ARGS);
 static int               pre_I(DECL_ARGS);
+static int               pre_IB(DECL_ARGS);
+static int               pre_IP(DECL_ARGS);
+static int               pre_IR(DECL_ARGS);
 static int               pre_PP(DECL_ARGS);
+static int               pre_RB(DECL_ARGS);
+static int               pre_RI(DECL_ARGS);
 static int               pre_SH(DECL_ARGS);
 static int               pre_SS(DECL_ARGS);
 static int               pre_TP(DECL_ARGS);
@@ -47,7 +58,7 @@ static        void              post_SH(DECL_ARGS);
 static void              post_SS(DECL_ARGS);
 
 static const struct termact termacts[MAN_MAX] = {
-       { NULL, NULL }, /* __ */
+       { pre_br, NULL }, /* br */
        { NULL, NULL }, /* TH */
        { pre_SH, post_SH }, /* SH */
        { pre_SS, post_SS }, /* SS */
@@ -55,19 +66,21 @@ static const struct termact termacts[MAN_MAX] = {
        { pre_PP, NULL }, /* LP */
        { pre_PP, NULL }, /* PP */
        { pre_PP, NULL }, /* P */
-       { NULL, NULL }, /* IP */
-       { pre_PP, NULL }, /* HP */ /* XXX */
+       { pre_IP, NULL }, /* IP */
+       { pre_PP, NULL }, /* HP */ /* FIXME */
        { NULL, NULL }, /* SM */
        { pre_B, post_B }, /* SB */
-       { NULL, NULL }, /* BI */
-       { NULL, NULL }, /* IB */
-       { NULL, NULL }, /* BR */
-       { NULL, NULL }, /* RB */
+       { pre_BI, NULL }, /* BI */
+       { pre_IB, NULL }, /* IB */
+       { pre_BR, NULL }, /* BR */
+       { pre_RB, NULL }, /* RB */
        { NULL, NULL }, /* R */
        { pre_B, post_B }, /* B */
        { pre_I, post_I }, /* I */
-       { NULL, NULL }, /* IR */
-       { NULL, NULL }, /* RI */
+       { pre_IR, NULL }, /* IR */
+       { pre_RI, NULL }, /* RI */
+       { NULL, NULL }, /* na */
+       { pre_I, post_I }, /* i */
 };
 
 static void              print_head(struct termp *, 
@@ -84,13 +97,17 @@ man_run(struct termp *p, const struct man *m)
 
        print_head(p, man_meta(m));
        p->flags |= TERMP_NOSPACE;
-       print_body(p, man_node(m), man_meta(m));
+       assert(man_node(m));
+       assert(MAN_ROOT == man_node(m)->type);
+       if (man_node(m)->child)
+               print_body(p, man_node(m)->child, man_meta(m));
        print_foot(p, man_meta(m));
 
        return(1);
 }
 
 
+/* ARGSUSED */
 static int
 pre_I(DECL_ARGS)
 {
@@ -100,6 +117,7 @@ pre_I(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
 static void
 post_I(DECL_ARGS)
 {
@@ -108,6 +126,123 @@ post_I(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
+static int
+pre_IR(DECL_ARGS)
+{
+       const struct man_node *nn;
+       int              i;
+
+       for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
+               if ( ! (i % 2))
+                       p->flags |= TERMP_UNDER;
+               if (i > 0)
+                       p->flags |= TERMP_NOSPACE;
+               print_node(p, nn, m);
+               if ( ! (i % 2))
+                       p->flags &= ~TERMP_UNDER;
+       }
+       return(0);
+}
+
+
+/* ARGSUSED */
+static int
+pre_IB(DECL_ARGS)
+{
+       const struct man_node *nn;
+       int              i;
+
+       for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
+               p->flags |= i % 2 ? TERMP_BOLD : TERMP_UNDER;
+               if (i > 0)
+                       p->flags |= TERMP_NOSPACE;
+               print_node(p, nn, m);
+               p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER;
+       }
+       return(0);
+}
+
+
+/* ARGSUSED */
+static int
+pre_RB(DECL_ARGS)
+{
+       const struct man_node *nn;
+       int              i;
+
+       for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
+               if (i % 2)
+                       p->flags |= TERMP_BOLD;
+               if (i > 0)
+                       p->flags |= TERMP_NOSPACE;
+               print_node(p, nn, m);
+               if (i % 2)
+                       p->flags &= ~TERMP_BOLD;
+       }
+       return(0);
+}
+
+
+/* ARGSUSED */
+static int
+pre_RI(DECL_ARGS)
+{
+       const struct man_node *nn;
+       int              i;
+
+       for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
+               if ( ! (i % 2))
+                       p->flags |= TERMP_UNDER;
+               if (i > 0)
+                       p->flags |= TERMP_NOSPACE;
+               print_node(p, nn, m);
+               if ( ! (i % 2))
+                       p->flags &= ~TERMP_UNDER;
+       }
+       return(0);
+}
+
+
+/* ARGSUSED */
+static int
+pre_BR(DECL_ARGS)
+{
+       const struct man_node *nn;
+       int              i;
+
+       for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
+               if ( ! (i % 2))
+                       p->flags |= TERMP_BOLD;
+               if (i > 0)
+                       p->flags |= TERMP_NOSPACE;
+               print_node(p, nn, m);
+               if ( ! (i % 2))
+                       p->flags &= ~TERMP_BOLD;
+       }
+       return(0);
+}
+
+
+/* ARGSUSED */
+static int
+pre_BI(DECL_ARGS)
+{
+       const struct man_node *nn;
+       int              i;
+
+       for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
+               p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD;
+               if (i > 0)
+                       p->flags |= TERMP_NOSPACE;
+               print_node(p, nn, m);
+               p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD;
+       }
+       return(0);
+}
+
+
+/* ARGSUSED */
 static int
 pre_B(DECL_ARGS)
 {
@@ -117,6 +252,7 @@ pre_B(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
 static void
 post_B(DECL_ARGS)
 {
@@ -125,6 +261,17 @@ post_B(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
+static int
+pre_br(DECL_ARGS)
+{
+
+       term_newln(p);
+       return(0);
+}
+
+
+/* ARGSUSED */
 static int
 pre_PP(DECL_ARGS)
 {
@@ -135,6 +282,42 @@ pre_PP(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
+static int
+pre_IP(DECL_ARGS)
+{
+#if 0
+       const struct man_node *nn;
+       size_t           offs;
+#endif
+
+       term_vspace(p);
+       p->offset = INDENT;
+
+#if 0
+       if (NULL == (nn = n->child))
+               return(1);
+       if (MAN_TEXT != nn->type)
+               errx(1, "expected text line argument");
+
+       if (nn->next) {
+               if (MAN_TEXT != nn->next->type)
+                       errx(1, "expected text line argument");
+               offs = (size_t)atoi(nn->next->string);
+       } else
+               offs = strlen(nn->string);
+
+       p->flags |= TERMP_NOSPACE;
+       /* FIXME */
+       if ((p->offset += offs) > p->rmargin)
+               errx(1, "line too long");
+#endif
+
+       return(0);
+}
+
+
+/* ARGSUSED */
 static int
 pre_TP(DECL_ARGS)
 {
@@ -142,6 +325,7 @@ pre_TP(DECL_ARGS)
        size_t           offs;
 
        term_vspace(p);
+
        p->offset = INDENT;
 
        if (NULL == (nn = n->child))
@@ -150,7 +334,7 @@ pre_TP(DECL_ARGS)
        if (nn->line == n->line) {
                if (MAN_TEXT != nn->type)
                        errx(1, "expected text line argument");
-               offs = atoi(nn->string);
+               offs = (size_t)atoi(nn->string);
                nn = nn->next;
        } else
                offs = INDENT;
@@ -165,6 +349,7 @@ pre_TP(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
 static int
 pre_SS(DECL_ARGS)
 {
@@ -175,6 +360,7 @@ pre_SS(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
 static void
 post_SS(DECL_ARGS)
 {
@@ -185,6 +371,7 @@ post_SS(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
 static int
 pre_SH(DECL_ARGS)
 {
@@ -196,6 +383,7 @@ pre_SH(DECL_ARGS)
 }
 
 
+/* ARGSUSED */
 static void
 post_SH(DECL_ARGS)
 {
@@ -210,7 +398,7 @@ post_SH(DECL_ARGS)
 static void
 print_node(DECL_ARGS)
 {
-       int              c;
+       int              c, sz;
 
        c = 1;
 
@@ -220,11 +408,21 @@ print_node(DECL_ARGS)
                        c = (*termacts[n->tok].pre)(p, n, m);
                break;
        case(MAN_TEXT):
-               if (*n->string) {
-                       term_word(p, n->string);
+               if (0 == *n->string) {
+                       term_vspace(p);
                        break;
                }
-               term_vspace(p);
+               /*
+                * Note!  This is hacky.  Here, we recognise the `\c'
+                * escape embedded in so many -man pages.  It's supposed
+                * to remove the subsequent space, so we mark NOSPACE if
+                * it's encountered in the string.
+                */
+               sz = (int)strlen(n->string);
+               term_word(p, n->string);
+               if (sz >= 2 && n->string[sz - 1] == 'c' &&
+                               n->string[sz - 2] == '\\')
+                       p->flags |= TERMP_NOSPACE;
                break;
        default:
                break;
@@ -265,20 +463,9 @@ print_foot(struct termp *p, const struct man_meta *meta)
 
        tm = localtime(&meta->date);
 
-#ifdef __OpenBSD__
-       if (NULL == strftime(buf, p->rmargin, "%B %d, %Y", tm))
-#else
        if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm))
-#endif
                err(1, "strftime");
 
-       /*
-        * This is /slightly/ different from regular groff output
-        * because we don't have page numbers.  Print the following:
-        *
-        * OS                                            MDOCDATE
-        */
-
        term_vspace(p);
 
        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
@@ -316,19 +503,6 @@ print_head(struct termp *p, const struct man_meta *meta)
        if (NULL == (title = malloc(p->rmargin)))
                err(1, "malloc");
 
-       /*
-        * The header is strange.  It has three components, which are
-        * really two with the first duplicated.  It goes like this:
-        *
-        * IDENTIFIER              TITLE                   IDENTIFIER
-        *
-        * The IDENTIFIER is NAME(SECTION), which is the command-name
-        * (if given, or "unknown" if not) followed by the manual page
-        * section.  These are given in `Dt'.  The TITLE is a free-form
-        * string depending on the manual volume.  If not specified, it
-        * switches on the manual section.
-        */
-
        if (meta->vol)
                (void)strlcpy(buf, meta->vol, p->rmargin);
        else
@@ -338,7 +512,7 @@ print_head(struct termp *p, const struct man_meta *meta)
                        meta->title, meta->msec);
 
        p->offset = 0;
-       p->rmargin = (p->maxrmargin - strlen(buf)) / 2;
+       p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;
        p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
 
        term_word(p, title);