-/* $Id: mdoc_html.c,v 1.23 2009/10/07 12:35:24 kristaps Exp $ */
+/* $Id: mdoc_html.c,v 1.54 2010/01/30 08:42:20 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
* 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 <sys/param.h>
-#include <sys/queue.h>
#include <assert.h>
#include <ctype.h>
-#include <err.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "out.h"
#include "html.h"
#include "mdoc.h"
+#include "main.h"
#define INDENT 5
#define HALFINDENT 3
const struct mdoc_node *n, \
struct html *h
+#ifndef MIN
+#define MIN(a,b) ((/*CONSTCOND*/(a)<(b))?(a):(b))
+#endif
+
struct htmlmdoc {
int (*pre)(MDOC_ARGS);
void (*post)(MDOC_ARGS);
static void a2width(const char *, struct roffsu *);
static void a2offs(const char *, struct roffsu *);
+
static int a2list(const struct mdoc_node *);
static void mdoc_root_post(MDOC_ARGS);
static int mdoc_root_pre(MDOC_ARGS);
-static int mdoc_it_block_pre(MDOC_ARGS, int,
- struct roffsu *, int,
- struct roffsu *);
-static int mdoc_it_head_pre(MDOC_ARGS, int,
- struct roffsu *);
-static int mdoc_it_body_pre(MDOC_ARGS, int);
static void mdoc__x_post(MDOC_ARGS);
static int mdoc__x_pre(MDOC_ARGS);
static int mdoc_fo_pre(MDOC_ARGS);
static int mdoc_ic_pre(MDOC_ARGS);
static int mdoc_in_pre(MDOC_ARGS);
+static int mdoc_it_block_pre(MDOC_ARGS, int, int,
+ struct roffsu *, struct roffsu *);
+static int mdoc_it_head_pre(MDOC_ARGS, int,
+ struct roffsu *);
+static int mdoc_it_body_pre(MDOC_ARGS, int);
static int mdoc_it_pre(MDOC_ARGS);
static int mdoc_lb_pre(MDOC_ARGS);
static int mdoc_li_pre(MDOC_ARGS);
static int mdoc_xr_pre(MDOC_ARGS);
static int mdoc_xx_pre(MDOC_ARGS);
-#ifdef __linux__
-extern size_t strlcpy(char *, const char *, size_t);
-extern size_t strlcat(char *, const char *, size_t);
-#endif
-
static const struct htmlmdoc mdocs[MDOC_MAX] = {
{mdoc_ap_pre, NULL}, /* Ap */
{NULL, NULL}, /* Dd */
{mdoc__x_pre, mdoc__x_post}, /* %Q */
{mdoc_sp_pre, NULL}, /* br */
{mdoc_sp_pre, NULL}, /* sp */
+ {mdoc__x_pre, mdoc__x_post}, /* %U */
};
h = (struct html *)arg;
- print_gen_doctype(h);
+ print_gen_decls(h);
t = print_otag(h, TAG_HTML, 0, NULL);
print_mdoc(mdoc_meta(m), mdoc_node(m), h);
print_tagq(h, t);
a2width(const char *p, struct roffsu *su)
{
- if ( ! a2roffsu(p, su))
- SCALE_HS_INIT(su, (int)strlen(p));
+ if ( ! a2roffsu(p, su, SCALE_MAX)) {
+ su->unit = SCALE_EM;
+ su->scale = (int)strlen(p);
+ }
}
a2offs(const char *p, struct roffsu *su)
{
+ /* FIXME: "right"? */
+
if (0 == strcmp(p, "left"))
SCALE_HS_INIT(su, 0);
else if (0 == strcmp(p, "indent"))
SCALE_HS_INIT(su, INDENT);
else if (0 == strcmp(p, "indent-two"))
SCALE_HS_INIT(su, INDENT * 2);
- else if ( ! a2roffsu(p, su))
- SCALE_HS_INIT(su, (int)strlen(p));
+ else if ( ! a2roffsu(p, su, SCALE_MAX)) {
+ su->unit = SCALE_EM;
+ su->scale = (int)strlen(p);
+ }
}
struct tag *t;
child = 1;
- t = SLIST_FIRST(&h->tags);
+ t = h->tags.head;
bufinit(h);
switch (n->type) {
break;
case (MDOC_TEXT):
print_text(h, n->string);
- break;
+ return;
default:
if (mdocs[n->tok].pre)
child = (*mdocs[n->tok].pre)(m, n, h);
case (MDOC_ROOT):
mdoc_root_post(m, n, h);
break;
- case (MDOC_TEXT):
- break;
default:
if (mdocs[n->tok].post)
(*mdocs[n->tok].post)(m, n, h);
static void
mdoc_root_post(MDOC_ARGS)
{
- struct tm tm;
- struct htmlpair tag[2];
+ struct htmlpair tag[3];
struct tag *t, *tt;
- char b[BUFSIZ];
+ char b[DATESIZ];
+
+ time2a(m->date, b, DATESIZ);
/*
* XXX: this should use divs, but in Firefox, divs with nested
* below. So I use tables, instead.
*/
- (void)localtime_r(&m->date, &tm);
-
- if (0 == strftime(b, BUFSIZ - 1, "%B %e, %Y", &tm))
- err(EXIT_FAILURE, "strftime");
-
PAIR_CLASS_INIT(&tag[0], "footer");
bufcat_style(h, "width", "100%");
PAIR_STYLE_INIT(&tag[1], h);
- t = print_otag(h, TAG_TABLE, 2, tag);
+ PAIR_SUMMARY_INIT(&tag[2], "footer");
+
+ t = print_otag(h, TAG_TABLE, 3, tag);
tt = print_otag(h, TAG_TR, 0, NULL);
bufinit(h);
static int
mdoc_root_pre(MDOC_ARGS)
{
- struct htmlpair tag[2];
+ struct htmlpair tag[3];
struct tag *t, *tt;
char b[BUFSIZ], title[BUFSIZ];
PAIR_CLASS_INIT(&tag[0], "header");
bufcat_style(h, "width", "100%");
PAIR_STYLE_INIT(&tag[1], h);
- t = print_otag(h, TAG_TABLE, 2, tag);
+ PAIR_SUMMARY_INIT(&tag[2], "header");
+
+ t = print_otag(h, TAG_TABLE, 3, tag);
+
tt = print_otag(h, TAG_TR, 0, NULL);
bufinit(h);
{
struct htmlpair tag[2];
const struct mdoc_node *nn;
- char link[BUFSIZ];
+ char buf[BUFSIZ];
struct roffsu su;
if (MDOC_BODY == n->type) {
return(1);
}
- link[0] = 0;
+ buf[0] = '\0';
for (nn = n->child; nn; nn = nn->next) {
- (void)strlcat(link, nn->string, BUFSIZ);
+ html_idcat(buf, nn->string, BUFSIZ);
if (nn->next)
- (void)strlcat(link, "_", BUFSIZ);
+ html_idcat(buf, " ", BUFSIZ);
}
/*
PAIR_CLASS_INIT(&tag[0], "sec-head");
tag[1].key = ATTR_ID;
- tag[1].val = link;
+ tag[1].val = buf;
print_otag(h, TAG_DIV, 2, tag);
return(1);
}
{
struct htmlpair tag[3];
const struct mdoc_node *nn;
- char link[BUFSIZ];
+ char buf[BUFSIZ];
struct roffsu su;
SCALE_VS_INIT(&su, 1);
/* TODO: see note in mdoc_sh_pre() about duplicates. */
- link[0] = 0;
+ buf[0] = '\0';
for (nn = n->child; nn; nn = nn->next) {
- (void)strlcat(link, nn->string, BUFSIZ);
+ html_idcat(buf, nn->string, BUFSIZ);
if (nn->next)
- (void)strlcat(link, "_", BUFSIZ);
+ html_idcat(buf, " ", BUFSIZ);
}
SCALE_HS_INIT(&su, INDENT - HALFINDENT);
PAIR_CLASS_INIT(&tag[0], "ssec-head");
PAIR_STYLE_INIT(&tag[1], h);
tag[2].key = ATTR_ID;
- tag[2].val = link;
+ tag[2].val = buf;
print_otag(h, TAG_DIV, 3, tag);
return(1);
}
PAIR_CLASS_INIT(&tag, "flag");
print_otag(h, TAG_SPAN, 1, &tag);
- if (MDOC_Fl == n->tok) {
- print_text(h, "\\-");
+
+ /* `Cm' has no leading hyphen. */
+
+ if (MDOC_Cm == n->tok)
+ return(1);
+
+ print_text(h, "\\-");
+
+ /* A blank `Fl' should incur a subsequent space. */
+
+ if (n->child)
h->flags |= HTML_NOSPACE;
- }
+
return(1);
}
if (MDOC_BODY != n->type)
return(1);
- /* XXX - this can contain block elements! */
+ /* XXX: this tag in theory can contain block elements. */
+
print_text(h, "\\(em");
PAIR_CLASS_INIT(&tag, "desc-body");
print_otag(h, TAG_SPAN, 1, &tag);
if (MDOC_BODY != n->type)
return(1);
- /* XXX - this can contain block elements! */
+ /* XXX: this tag in theory can contain block elements. */
+
print_text(h, "\\(lB");
h->flags |= HTML_NOSPACE;
PAIR_CLASS_INIT(&tag, "opt");
{
struct htmlpair tag;
- if ( ! (HTML_NEWLINE & h->flags))
- if (SEC_SYNOPSIS == n->sec) {
- bufcat_style(h, "clear", "both");
- PAIR_STYLE_INIT(&tag, h);
- print_otag(h, TAG_BR, 1, &tag);
- }
+ if (SEC_SYNOPSIS == n->sec && n->prev) {
+ bufcat_style(h, "clear", "both");
+ PAIR_STYLE_INIT(&tag, h);
+ print_otag(h, TAG_BR, 1, &tag);
+ }
PAIR_CLASS_INIT(&tag, "name");
print_otag(h, TAG_SPAN, 1, &tag);
pp = "BSDI BSD/OS";
break;
case (MDOC_Dx):
- pp = "DragonFlyBSD";
+ pp = "DragonFly";
break;
case (MDOC_Fx):
pp = "FreeBSD";
/* ARGSUSED */
static int
-mdoc_it_block_pre(MDOC_ARGS, int type, struct roffsu *offs,
- int comp, struct roffsu *width)
+mdoc_it_block_pre(MDOC_ARGS, int type, int comp,
+ struct roffsu *offs, struct roffsu *width)
{
struct htmlpair tag;
const struct mdoc_node *nn;
nn = n->parent->parent;
assert(nn->args);
- if (MDOC_Column == type)
- comp = 0;
+ /* XXX: see notes in mdoc_it_pre(). */
+
+ if (MDOC_Column == type) {
+ /* Don't width-pad on the left. */
+ SCALE_HS_INIT(width, 0);
+ /* Also disallow non-compact. */
+ comp = 1;
+ }
if (MDOC_Diag == type)
+ /* Mandate non-compact with empty prior. */
if (n->prev && NULL == n->prev->body->child)
comp = 1;
+ bufcat_style(h, "clear", "both");
if (offs->scale > 0)
bufcat_su(h, "margin-left", offs);
if (width->scale > 0)
PAIR_STYLE_INIT(&tag, h);
+ /* Mandate compact following `Ss' and `Sh' starts. */
+
for (nn = n; nn && ! comp; nn = nn->parent) {
if (MDOC_BLOCK != nn->type)
continue;
}
+/* ARGSUSED */
static int
mdoc_it_body_pre(MDOC_ARGS, int type)
{
case (MDOC_Column):
break;
default:
+ /*
+ * XXX: this tricks CSS into aligning the bodies with
+ * the right-padding in the head.
+ */
SCALE_HS_INIT(&su, 2);
bufcat_su(h, "margin-left", &su);
PAIR_STYLE_INIT(&tag, h);
}
+/* ARGSUSED */
static int
mdoc_it_head_pre(MDOC_ARGS, int type, struct roffsu *width)
{
switch (type) {
case (MDOC_Item):
- /* FALLTHROUGH */
+ return(0);
case (MDOC_Ohang):
- print_otag(h, TAG_DIV, 0, NULL);
- break;
+ print_otag(h, TAG_DIV, 0, &tag);
+ return(1);
case (MDOC_Column):
bufcat_su(h, "min-width", width);
bufcat_style(h, "clear", "none");
bufcat_su(h, "margin-left", width);
if (n->next && n->next->child)
bufcat_style(h, "float", "left");
+
+ /* XXX: buffer if we run into body. */
SCALE_HS_INIT(width, 1);
bufcat_su(h, "margin-right", width);
PAIR_STYLE_INIT(&tag, h);
print_otag(h, TAG_SPAN, 1, &tag);
break;
case (MDOC_Enum):
- ord = SLIST_FIRST(&h->ords);
+ ord = h->ords.head;
assert(ord);
nbuf[BUFSIZ - 1] = 0;
(void)snprintf(nbuf, BUFSIZ - 1, "%d.", ord->pos++);
const struct mdoc_node *bl, *nn;
struct roffsu width, offs;
- /* This is the `Bl' block parent. */
+ /*
+ * XXX: be very careful in changing anything, here. Lists in
+ * mandoc have many peculiarities; furthermore, they don't
+ * translate well into HTML and require a bit of mangling.
+ */
bl = n->parent->parent;
if (MDOC_BLOCK != n->type)
/* Set default width and offset. */
+ SCALE_HS_INIT(&offs, 0);
+
switch (type) {
case (MDOC_Enum):
/* FALLTHROUGH */
break;
}
- SCALE_HS_INIT(&offs, 0);
-
/* Get width, offset, and compact arguments. */
for (wp = -1, comp = i = 0; i < (int)bl->args->argc; i++)
switch (bl->args->argv[i].arg) {
+ case (MDOC_Column):
+ wp = i; /* Save for later. */
+ break;
case (MDOC_Width):
- wp = i; /* Save offset. */
a2width(bl->args->argv[i].value[0], &width);
break;
case (MDOC_Offset):
/* Override width in some cases. */
switch (type) {
+ case (MDOC_Ohang):
+ /* FALLTHROUGH */
+ case (MDOC_Item):
+ /* FALLTHROUGH */
case (MDOC_Inset):
/* FALLTHROUGH */
case (MDOC_Diag):
if (MDOC_BODY == n->type)
return(mdoc_it_body_pre(m, n, h, type));
if (MDOC_BLOCK == n->type)
- return(mdoc_it_block_pre(m, n, h, type,
- &offs, comp, &width));
+ return(mdoc_it_block_pre(m, n, h, type, comp,
+ &offs, &width));
/* Override column widths. */
nn = n->parent->child;
for (i = 0; nn && nn != n; nn = nn->next, i++)
/* Counter... */ ;
- if (wp >= 0 && i < (int)bl->args[wp].argv->sz)
+ if (i < (int)bl->args->argv[wp].sz)
a2width(bl->args->argv[wp].value[i], &width);
}
return(1);
ord = malloc(sizeof(struct ord));
- if (NULL == ord)
- err(EXIT_FAILURE, "malloc");
+ if (NULL == ord) {
+ perror(NULL);
+ exit(EXIT_FAILURE);
+ }
ord->cookie = n;
ord->pos = 1;
- SLIST_INSERT_HEAD(&h->ords, ord, entry);
+ ord->next = h->ords.head;
+ h->ords.head = ord;
return(1);
}
if (MDOC_Enum != a2list(n))
return;
- ord = SLIST_FIRST(&h->ords);
+ ord = h->ords.head;
assert(ord);
- SLIST_REMOVE_HEAD(&h->ords, entry);
+ h->ords.head = ord->next;
free(ord);
}
if (MDOC_BLOCK != n->type)
return(1);
+ /* FIXME: D1 shouldn't be literal. */
+
SCALE_VS_INIT(&su, INDENT - 2);
bufcat_su(h, "margin-left", &su);
PAIR_CLASS_INIT(&tag[0], "lit");
{
struct htmlpair tag[2];
const struct mdoc_node *nn;
- char link[BUFSIZ];
+ char buf[BUFSIZ];
/* FIXME: duplicates? */
- (void)strlcpy(link, "#", BUFSIZ);
+ strlcpy(buf, "#", BUFSIZ);
for (nn = n->child; nn; nn = nn->next) {
- (void)strlcat(link, nn->string, BUFSIZ);
+ html_idcat(buf, nn->string, BUFSIZ);
if (nn->next)
- (void)strlcat(link, "_", BUFSIZ);
+ html_idcat(buf, " ", BUFSIZ);
}
PAIR_CLASS_INIT(&tag[0], "link-sec");
tag[1].key = ATTR_HREF;
- tag[1].val = link;
+ tag[1].val = buf;
print_otag(h, TAG_A, 2, tag);
return(1);
else
bl = n->parent;
+ SCALE_VS_INIT(&su, 0);
+
type = comp = 0;
for (i = 0; i < (int)bl->args->argc; i++)
switch (bl->args->argv[i].arg) {
case (MDOC_Offset):
a2offs(bl->args->argv[i].value[0], &su);
- bufcat_su(h, "margin-left", &su);
break;
case (MDOC_Compact):
comp = 1;
break;
+ case (MDOC_Centred):
+ /* FALLTHROUGH */
case (MDOC_Ragged):
/* FALLTHROUGH */
case (MDOC_Filled):
case (MDOC_Literal):
type = bl->args->argv[i].arg;
break;
+ default:
+ break;
}
+ /* FIXME: -centered, etc. formatting. */
+
if (MDOC_BLOCK == n->type) {
+ bufcat_su(h, "margin-left", &su);
for (nn = n; nn && ! comp; nn = nn->parent) {
if (MDOC_BLOCK != nn->type)
continue;
{
struct htmlpair tag;
+ print_otag(h, TAG_DIV, 0, NULL);
PAIR_CLASS_INIT(&tag, "config");
print_otag(h, TAG_SPAN, 1, &tag);
return(1);
struct htmlpair tag;
struct roffsu su;
- if (SEC_SYNOPSIS == n->sec) {
- if (n->next && MDOC_Vt != n->next->tok) {
+ if (MDOC_BLOCK == n->type) {
+ if (n->prev && MDOC_Vt != n->prev->tok) {
SCALE_VS_INIT(&su, 1);
- bufcat_su(h, "margin-bottom", &su);
+ bufcat_su(h, "margin-top", &su);
PAIR_STYLE_INIT(&tag, h);
print_otag(h, TAG_DIV, 1, &tag);
} else
print_otag(h, TAG_DIV, 0, NULL);
- }
+
+ return(1);
+ } else if (MDOC_HEAD == n->type)
+ return(0);
PAIR_CLASS_INIT(&tag, "type");
print_otag(h, TAG_SPAN, 1, &tag);
assert(n->child->string);
sp = n->child->string;
- if ((ep = strchr(sp, ' '))) {
+ ep = strchr(sp, ' ');
+ if (NULL != ep) {
PAIR_CLASS_INIT(&tag[0], "ftype");
t = print_otag(h, TAG_SPAN, 1, tag);
bufcat_su(h, "height", &su);
PAIR_STYLE_INIT(&tag, h);
print_otag(h, TAG_DIV, 1, &tag);
- return(1);
+ /* So the div isn't empty: */
+ print_text(h, "\\~");
+
+ return(0);
}
tag[1].val = nn->string;
print_otag(h, TAG_A, 2, tag);
+ if (NULL == nn->next)
+ return(1);
+
for (nn = nn->next; nn; nn = nn->next)
print_text(h, nn->string);
print_otag(h, TAG_DIV, 0, NULL);
}
+ /* FIXME: there's a buffer bug in here somewhere. */
+
PAIR_CLASS_INIT(&tag[0], "includes");
print_otag(h, TAG_SPAN, 1, tag);
for (nn = n->child; nn; nn = nn->next) {
PAIR_CLASS_INIT(&tag[0], "link-includes");
i = 1;
+ bufinit(h);
if (h->base_includes) {
buffmt_includes(h, nn->string);
tag[i].key = ATTR_HREF;
static int
mdoc__x_pre(MDOC_ARGS)
{
- struct htmlpair tag;
+ struct htmlpair tag[2];
switch (n->tok) {
case(MDOC__A):
- PAIR_CLASS_INIT(&tag, "ref-auth");
+ PAIR_CLASS_INIT(&tag[0], "ref-auth");
break;
case(MDOC__B):
- PAIR_CLASS_INIT(&tag, "ref-book");
+ PAIR_CLASS_INIT(&tag[0], "ref-book");
break;
case(MDOC__C):
- PAIR_CLASS_INIT(&tag, "ref-city");
+ PAIR_CLASS_INIT(&tag[0], "ref-city");
break;
case(MDOC__D):
- PAIR_CLASS_INIT(&tag, "ref-date");
+ PAIR_CLASS_INIT(&tag[0], "ref-date");
break;
case(MDOC__I):
- PAIR_CLASS_INIT(&tag, "ref-issue");
+ PAIR_CLASS_INIT(&tag[0], "ref-issue");
break;
case(MDOC__J):
- PAIR_CLASS_INIT(&tag, "ref-jrnl");
+ PAIR_CLASS_INIT(&tag[0], "ref-jrnl");
break;
case(MDOC__N):
- PAIR_CLASS_INIT(&tag, "ref-num");
+ PAIR_CLASS_INIT(&tag[0], "ref-num");
break;
case(MDOC__O):
- PAIR_CLASS_INIT(&tag, "ref-opt");
+ PAIR_CLASS_INIT(&tag[0], "ref-opt");
break;
case(MDOC__P):
- PAIR_CLASS_INIT(&tag, "ref-page");
+ PAIR_CLASS_INIT(&tag[0], "ref-page");
break;
case(MDOC__Q):
- PAIR_CLASS_INIT(&tag, "ref-corp");
+ PAIR_CLASS_INIT(&tag[0], "ref-corp");
break;
case(MDOC__R):
- PAIR_CLASS_INIT(&tag, "ref-rep");
+ PAIR_CLASS_INIT(&tag[0], "ref-rep");
break;
case(MDOC__T):
- PAIR_CLASS_INIT(&tag, "ref-title");
+ PAIR_CLASS_INIT(&tag[0], "ref-title");
print_text(h, "\\(lq");
h->flags |= HTML_NOSPACE;
break;
+ case(MDOC__U):
+ PAIR_CLASS_INIT(&tag[0], "link-ref");
+ break;
case(MDOC__V):
- PAIR_CLASS_INIT(&tag, "ref-vol");
+ PAIR_CLASS_INIT(&tag[0], "ref-vol");
break;
default:
abort();
/* NOTREACHED */
}
- print_otag(h, TAG_SPAN, 1, &tag);
+ if (MDOC__U != n->tok) {
+ print_otag(h, TAG_SPAN, 1, tag);
+ return(1);
+ }
+
+ PAIR_HREF_INIT(&tag[1], n->child->string);
+ print_otag(h, TAG_A, 2, tag);
return(1);
}
git.ckatri.com / mandoc.git / blobdiff