=================================================================== RCS file: /cvs/mandoc/mdoc_term.c,v retrieving revision 1.8 retrieving revision 1.27 diff -u -p -r1.8 -r1.27 --- mandoc/mdoc_term.c 2009/06/11 07:26:35 1.8 +++ mandoc/mdoc_term.c 2009/07/12 16:55:11 1.27 @@ -1,4 +1,4 @@ -/* $Id: mdoc_term.c,v 1.8 2009/06/11 07:26:35 kristaps Exp $ */ +/* $Id: mdoc_term.c,v 1.27 2009/07/12 16:55:11 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -86,10 +86,10 @@ struct termpair { struct termpair *ppair; int type; #define TERMPAIR_FLAG (1 << 0) - int flag; - size_t offset; - size_t rmargin; - int count; + int flag; /* Whether being used. */ + size_t offset; /* Left margin. */ + size_t rmargin; /* Right margin. */ + int count; /* Enum count. */ }; #define TERMPAIR_SETFLAG(termp, p, fl) \ @@ -141,16 +141,13 @@ DECL_PRE(termp_ap); DECL_PRE(termp_ar); DECL_PRE(termp_at); DECL_PRE(termp_bf); -DECL_PRE(termp_bsx); DECL_PRE(termp_bt); DECL_PRE(termp_cd); DECL_PRE(termp_cm); -DECL_PRE(termp_dx); DECL_PRE(termp_em); DECL_PRE(termp_ex); DECL_PRE(termp_fa); DECL_PRE(termp_fl); -DECL_PRE(termp_fx); DECL_PRE(termp_ic); DECL_PRE(termp_lk); DECL_PRE(termp_ms); @@ -158,8 +155,7 @@ DECL_PRE(termp_mt); DECL_PRE(termp_nd); DECL_PRE(termp_nm); DECL_PRE(termp_ns); -DECL_PRE(termp_nx); -DECL_PRE(termp_ox); +DECL_PRE(termp_xx); DECL_PRE(termp_pa); DECL_PRE(termp_pp); DECL_PRE(termp_rs); @@ -169,7 +165,6 @@ DECL_PRE(termp_st); DECL_PRE(termp_sx); DECL_PRE(termp_sy); DECL_PRE(termp_ud); -DECL_PRE(termp_ux); DECL_PRE(termp_va); DECL_PRE(termp_xr); @@ -183,7 +178,7 @@ struct termact { }; static const struct termact termacts[MDOC_MAX] = { - { NULL, NULL }, /* \" */ + { termp_ap_pre, NULL }, /* Ap */ { NULL, NULL }, /* Dd */ { NULL, NULL }, /* Dt */ { NULL, NULL }, /* Os */ @@ -243,7 +238,7 @@ static const struct termact termacts[MDOC_MAX] = { { termp_bf_pre, NULL }, /* Bf */ { termp_bq_pre, termp_bq_post }, /* Bo */ { termp_bq_pre, termp_bq_post }, /* Bq */ - { termp_bsx_pre, NULL }, /* Bsx */ + { termp_xx_pre, NULL }, /* Bsx */ { NULL, termp_bx_post }, /* Bx */ { NULL, NULL }, /* Db */ { NULL, NULL }, /* Dc */ @@ -253,12 +248,12 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* Ef */ { termp_em_pre, NULL }, /* Em */ { NULL, NULL }, /* Eo */ - { termp_fx_pre, NULL }, /* Fx */ + { termp_xx_pre, NULL }, /* Fx */ { termp_ms_pre, NULL }, /* Ms */ { NULL, NULL }, /* No */ { termp_ns_pre, NULL }, /* Ns */ - { termp_nx_pre, NULL }, /* Nx */ - { termp_ox_pre, NULL }, /* Ox */ + { termp_xx_pre, NULL }, /* Nx */ + { termp_xx_pre, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ { termp_pf_pre, termp_pf_post }, /* Pf */ { termp_pq_pre, termp_pq_post }, /* Po */ @@ -276,7 +271,7 @@ static const struct termact termacts[MDOC_MAX] = { { termp_sx_pre, NULL }, /* Sx */ { termp_sy_pre, NULL }, /* Sy */ { NULL, NULL }, /* Tn */ - { termp_ux_pre, NULL }, /* Ux */ + { termp_xx_pre, NULL }, /* Ux */ { NULL, NULL }, /* Xc */ { NULL, NULL }, /* Xo */ { termp_fo_pre, termp_fo_post }, /* Fo */ @@ -290,8 +285,7 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* Fr */ { termp_ud_pre, NULL }, /* Ud */ { termp_lb_pre, termp_lb_post }, /* Lb */ - { termp_ap_pre, NULL }, /* Lb */ - { termp_pp_pre, NULL }, /* Pp */ + { termp_pp_pre, NULL }, /* Lp */ { termp_lk_pre, NULL }, /* Lk */ { termp_mt_pre, NULL }, /* Mt */ { termp_brq_pre, termp_brq_post }, /* Brq */ @@ -300,13 +294,13 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* %C */ { NULL, NULL }, /* Es */ { NULL, NULL }, /* En */ - { termp_dx_pre, NULL }, /* Dx */ + { termp_xx_pre, NULL }, /* Dx */ { NULL, NULL }, /* %Q */ }; #ifdef __linux__ -extern size_t strlcpy(char *, const char *, size_t); -extern size_t strlcat(char *, const char *, size_t); +extern size_t strlcpy(char *, const char *, size_t); +extern size_t strlcat(char *, const char *, size_t); #endif static int arg_hasattr(int, const struct mdoc_node *); @@ -325,15 +319,21 @@ static void print_head(struct termp *, static void print_body(DECL_ARGS); static void print_foot(struct termp *, const struct mdoc_meta *); -static void sanity(const struct mdoc_node *); int mdoc_run(struct termp *p, const struct mdoc *m) { + /* + * Main output function. When this is called, assume that the + * tree is properly formed. + */ print_head(p, mdoc_meta(m)); - print_body(p, NULL, mdoc_meta(m), mdoc_node(m)); + assert(mdoc_node(m)); + assert(MDOC_ROOT == mdoc_node(m)->type); + if (mdoc_node(m)->child) + print_body(p, NULL, mdoc_meta(m), mdoc_node(m)->child); print_foot(p, mdoc_meta(m)); return(1); } @@ -356,10 +356,6 @@ print_node(DECL_ARGS) int dochild; struct termpair npair; - /* Some quick sanity-checking. */ - - sanity(node); - /* Pre-processing. */ dochild = 1; @@ -401,6 +397,14 @@ print_foot(struct termp *p, const struct mdoc_meta *me struct tm *tm; char *buf, *os; + /* + * Output the footer in new-groff style, that is, three columns + * with the middle being the manual date and flanking columns + * being the operating system: + * + * SYSTEM DATE SYSTEM + */ + if (NULL == (buf = malloc(p->rmargin))) err(1, "malloc"); if (NULL == (os = malloc(p->rmargin))) @@ -408,39 +412,39 @@ print_foot(struct termp *p, const struct mdoc_meta *me 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"); (void)strlcpy(os, meta->os, p->rmargin); - /* - * 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; - p->rmargin = p->maxrmargin - strlen(buf); p->offset = 0; + p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; + p->flags |= TERMP_NOSPACE | TERMP_NOBREAK; term_word(p, os); term_flushln(p); + p->offset = p->rmargin; + p->rmargin = p->maxrmargin - strlen(os); p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + + term_word(p, buf); + term_flushln(p); + p->offset = p->rmargin; p->rmargin = p->maxrmargin; p->flags &= ~TERMP_NOBREAK; + p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; - term_word(p, buf); + term_word(p, os); term_flushln(p); + p->offset = 0; + p->rmargin = p->maxrmargin; + p->flags = 0; + free(buf); free(os); } @@ -491,9 +495,9 @@ print_head(struct termp *p, const struct mdoc_meta *me term_word(p, title); term_flushln(p); - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; p->offset = p->rmargin; p->rmargin = p->maxrmargin - strlen(title); + p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; term_word(p, buf); term_flushln(p); @@ -506,8 +510,8 @@ print_head(struct termp *p, const struct mdoc_meta *me term_word(p, title); term_flushln(p); - p->rmargin = p->maxrmargin; p->offset = 0; + p->rmargin = p->maxrmargin; p->flags &= ~TERMP_NOSPACE; free(title); @@ -515,119 +519,6 @@ print_head(struct termp *p, const struct mdoc_meta *me } -static void -sanity(const struct mdoc_node *n) -{ - char *p; - - p = "regular form violated"; - - switch (n->type) { - case (MDOC_TEXT): - if (n->child) - errx(1, p); - if (NULL == n->parent) - errx(1, p); - if (NULL == n->string) - errx(1, p); - switch (n->parent->type) { - case (MDOC_TEXT): - /* FALLTHROUGH */ - case (MDOC_ROOT): - errx(1, p); - /* NOTREACHED */ - default: - break; - } - break; - case (MDOC_ELEM): - if (NULL == n->parent) - errx(1, p); - switch (n->parent->type) { - case (MDOC_TAIL): - /* FALLTHROUGH */ - case (MDOC_BODY): - /* FALLTHROUGH */ - case (MDOC_HEAD): - break; - default: - errx(1, p); - /* NOTREACHED */ - } - if (n->child) switch (n->child->type) { - case (MDOC_TEXT): - break; - default: - errx(1, p); - /* NOTREACHED */ - } - break; - case (MDOC_HEAD): - /* FALLTHROUGH */ - case (MDOC_BODY): - /* FALLTHROUGH */ - case (MDOC_TAIL): - if (NULL == n->parent) - errx(1, p); - if (MDOC_BLOCK != n->parent->type) - errx(1, p); - if (n->child) switch (n->child->type) { - case (MDOC_BLOCK): - /* FALLTHROUGH */ - case (MDOC_ELEM): - /* FALLTHROUGH */ - case (MDOC_TEXT): - break; - default: - errx(1, p); - /* NOTREACHED */ - } - break; - case (MDOC_BLOCK): - if (NULL == n->parent) - errx(1, p); - if (NULL == n->child) - errx(1, p); - switch (n->parent->type) { - case (MDOC_ROOT): - /* FALLTHROUGH */ - case (MDOC_HEAD): - /* FALLTHROUGH */ - case (MDOC_BODY): - /* FALLTHROUGH */ - case (MDOC_TAIL): - break; - default: - errx(1, p); - /* NOTREACHED */ - } - switch (n->child->type) { - case (MDOC_ROOT): - /* FALLTHROUGH */ - case (MDOC_ELEM): - errx(1, p); - /* NOTREACHED */ - default: - break; - } - break; - case (MDOC_ROOT): - if (n->parent) - errx(1, p); - if (NULL == n->child) - errx(1, p); - switch (n->child->type) { - case (MDOC_BLOCK): - break; - default: - errx(1, p); - /* NOTREACHED */ - } - break; - } -} - - static size_t arg_width(const struct mdoc_argv *arg, int pos) { @@ -636,10 +527,6 @@ arg_width(const struct mdoc_argv *arg, int pos) assert(pos < (int)arg->sz && pos >= 0); assert(arg->value[pos]); - if (0 == strcmp(arg->value[pos], "indent")) - return(INDENT); - if (0 == strcmp(arg->value[pos], "indent-two")) - return(INDENT * 2); if (0 == (len = (int)strlen(arg->value[pos]))) return(0); @@ -649,13 +536,14 @@ arg_width(const struct mdoc_argv *arg, int pos) break; if (i == len - 1) { - if ('n' == arg->value[pos][len - 1]) { + if ('n' == arg->value[pos][len - 1] || + 'm' == arg->value[pos][len - 1]) { v = (size_t)atoi(arg->value[pos]); - return(v); + return(v + 2); } } - return(strlen(arg->value[pos]) + 1); + return(strlen(arg->value[pos]) + 2); } @@ -694,6 +582,8 @@ arg_listtype(const struct mdoc_node *n) break; } + /* FIXME: mandated by parser. */ + errx(1, "list type not supported"); /* NOTREACHED */ } @@ -704,10 +594,15 @@ arg_offset(const struct mdoc_argv *arg) { assert(*arg->value); + if (0 == strcmp(*arg->value, "left")) + return(0); if (0 == strcmp(*arg->value, "indent")) - return(INDENT); + return(INDENT + 1); if (0 == strcmp(*arg->value, "indent-two")) - return(INDENT * 2); + return((INDENT + 1) * 2); + + /* FIXME: needs to support field-widths (10n, etc.). */ + return(strlen(*arg->value)); } @@ -811,7 +706,7 @@ termp_it_pre(DECL_ARGS) { const struct mdoc_node *bl, *n; char buf[7]; - int i, type, keys[3], vals[3]; + int i, type, keys[3], vals[3], sv; size_t width, offset; if (MDOC_BLOCK == node->type) @@ -857,7 +752,7 @@ termp_it_pre(DECL_ARGS) if (vals[0] >= 0) width = arg_width(&bl->args->argv[vals[0]], 0); if (vals[1] >= 0) - offset = arg_offset(&bl->args->argv[vals[1]]); + offset += arg_offset(&bl->args->argv[vals[1]]); break; } @@ -872,12 +767,14 @@ termp_it_pre(DECL_ARGS) /* FALLTHROUGH */ case (MDOC_Dash): /* FALLTHROUGH */ - case (MDOC_Enum): - /* FALLTHROUGH */ case (MDOC_Hyphen): if (width < 4) width = 4; break; + case (MDOC_Enum): + if (width < 5) + width = 5; + break; case (MDOC_Tag): if (0 == width) width = 10; @@ -887,11 +784,13 @@ termp_it_pre(DECL_ARGS) } /* - * Whitespace control. Inset bodies need an initial space. + * Whitespace control. Inset bodies need an initial space, + * while diagonal bodies need two. */ switch (type) { case (MDOC_Diag): + term_word(p, "\\ "); /* FALLTHROUGH */ case (MDOC_Inset): if (MDOC_BODY == node->type) @@ -995,18 +894,21 @@ termp_it_pre(DECL_ARGS) /* * The dash, hyphen, bullet and enum lists all have a special - * HEAD character. Print it now. + * HEAD character (temporarily bold, in some cases). */ + sv = p->flags; if (MDOC_HEAD == node->type) switch (type) { case (MDOC_Bullet): + p->flags |= TERMP_BOLD; term_word(p, "\\[bu]"); break; case (MDOC_Dash): /* FALLTHROUGH */ case (MDOC_Hyphen): - term_word(p, "\\-"); + p->flags |= TERMP_BOLD; + term_word(p, "\\(hy"); break; case (MDOC_Enum): (pair->ppair->ppair->count)++; @@ -1018,6 +920,8 @@ termp_it_pre(DECL_ARGS) break; } + p->flags = sv; /* Restore saved flags. */ + /* * If we're not going to process our children, indicate so here. */ @@ -1169,6 +1073,8 @@ termp_rv_pre(DECL_ARGS) { int i; + /* FIXME: mandated by parser. */ + if (-1 == (i = arg_getattr(MDOC_Std, node))) errx(1, "expected -std argument"); if (1 != node->args->argv[i].sz) @@ -1202,6 +1108,8 @@ termp_ex_pre(DECL_ARGS) { int i; + /* FIXME: mandated by parser? */ + if (-1 == (i = arg_getattr(MDOC_Std, node))) errx(1, "expected -std argument"); if (1 != node->args->argv[i].sz) @@ -1222,7 +1130,18 @@ static int termp_nd_pre(DECL_ARGS) { + if (MDOC_BODY != node->type) + return(1); + /* + * XXX: signed off by jmc@openbsd.org. This technically + * produces a minus sign after the Nd, which is wrong, but is + * consistent with the historic OpenBSD tmac file. + */ +#if defined(__OpenBSD__) || defined(__linux__) term_word(p, "\\-"); +#else + term_word(p, "\\(em"); +#endif return(1); } @@ -1255,8 +1174,9 @@ termp_xr_pre(DECL_ARGS) { const struct mdoc_node *n; - if (NULL == (n = node->child)) - errx(1, "expected text line argument"); + assert(node->child && MDOC_TEXT == node->child->type); + n = node->child; + term_word(p, n->string); if (NULL == (n = n->next)) return(0); @@ -1390,9 +1310,9 @@ termp_lb_pre(DECL_ARGS) { const char *lb; - if (NULL == node->child) - errx(1, "expected text line argument"); - if ((lb = mdoc_a2lib(node->child->string))) { + assert(node->child && MDOC_TEXT == node->child->type); + lb = mdoc_a2lib(node->child->string); + if (lb) { term_word(p, lb); return(0); } @@ -1428,7 +1348,8 @@ termp_d1_pre(DECL_ARGS) if (MDOC_BLOCK != node->type) return(1); term_newln(p); - p->offset += (pair->offset = INDENT); + pair->offset = INDENT + 1; + p->offset += pair->offset; return(1); } @@ -1499,8 +1420,7 @@ termp_fn_pre(DECL_ARGS) { const struct mdoc_node *n; - if (NULL == node->child) - errx(1, "expected text line arguments"); + assert(node->child && MDOC_TEXT == node->child->type); /* FIXME: can be "type funcname" "type varname"... */ @@ -1535,7 +1455,6 @@ termp_fn_post(DECL_ARGS) if (node->sec == SEC_SYNOPSIS && node->next) term_vspace(p); - } @@ -1607,6 +1526,8 @@ termp_bd_pre(DECL_ARGS) else if (MDOC_BODY != node->type) return(1); + /* FIXME: display type should be mandated by parser. */ + if (NULL == node->parent->args) errx(1, "missing display type"); @@ -1712,16 +1633,6 @@ termp_qq_post(DECL_ARGS) /* ARGSUSED */ -static int -termp_bsx_pre(DECL_ARGS) -{ - - term_word(p, "BSDI BSD/OS"); - return(1); -} - - -/* ARGSUSED */ static void termp_bx_post(DECL_ARGS) { @@ -1734,56 +1645,42 @@ termp_bx_post(DECL_ARGS) /* ARGSUSED */ static int -termp_ox_pre(DECL_ARGS) +termp_xx_pre(DECL_ARGS) { + const char *pp; - term_word(p, "OpenBSD"); - return(1); -} + pp = NULL; + switch (node->tok) { + case (MDOC_Bsx): + pp = "BSDI BSD/OS"; + break; + case (MDOC_Dx): + pp = "DragonFlyBSD"; + break; + case (MDOC_Fx): + pp = "FreeBSD"; + break; + case (MDOC_Nx): + pp = "NetBSD"; + break; + case (MDOC_Ox): + pp = "OpenBSD"; + break; + case (MDOC_Ux): + pp = "UNIX"; + break; + default: + break; + } - -/* ARGSUSED */ -static int -termp_dx_pre(DECL_ARGS) -{ - - term_word(p, "DragonFly"); + assert(pp); + term_word(p, pp); return(1); } /* ARGSUSED */ static int -termp_ux_pre(DECL_ARGS) -{ - - term_word(p, "UNIX"); - return(1); -} - - -/* ARGSUSED */ -static int -termp_fx_pre(DECL_ARGS) -{ - - term_word(p, "FreeBSD"); - return(1); -} - - -/* ARGSUSED */ -static int -termp_nx_pre(DECL_ARGS) -{ - - term_word(p, "NetBSD"); - return(1); -} - - -/* ARGSUSED */ -static int termp_sq_pre(DECL_ARGS) { @@ -1922,8 +1819,12 @@ static int termp_in_pre(DECL_ARGS) { + /* XXX This conforms to new-groff style. */ TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_INCLUDE]); - term_word(p, "#include"); + + if (SEC_SYNOPSIS == node->sec) + term_word(p, "#include"); + term_word(p, "<"); p->flags |= TERMP_NOSPACE; return(1); @@ -1938,9 +1839,16 @@ termp_in_post(DECL_ARGS) p->flags |= TERMP_NOSPACE; term_word(p, ">"); - term_newln(p); if (SEC_SYNOPSIS != node->sec) return; + + term_newln(p); + /* + * XXX Not entirely correct. If `.In foo bar' is specified in + * the SYNOPSIS section, then it produces a single break after + * the ; mandoc asserts a vertical space. Since this + * construction is rarely used, I think it's fine. + */ if (node->next && MDOC_In != node->next->tok) term_vspace(p); } @@ -2055,8 +1963,7 @@ termp_fo_pre(DECL_ARGS) p->flags |= ttypes[TTYPE_FUNC_NAME]; for (n = node->child; n; n = n->next) { - if (MDOC_TEXT != n->type) - errx(1, "expected text line argument"); + assert(MDOC_TEXT == n->type); term_word(p, n->string); } p->flags &= ~ttypes[TTYPE_FUNC_NAME]; @@ -2100,9 +2007,7 @@ termp_bf_pre(DECL_ARGS) return(1); } - if (MDOC_TEXT != n->type) - errx(1, "expected text line arguments"); - + assert(MDOC_TEXT == n->type); if (0 == strcmp("Em", n->string)) TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); else if (0 == strcmp("Sy", n->string)) @@ -2138,9 +2043,7 @@ static int termp_sm_pre(DECL_ARGS) { - if (NULL == node->child || MDOC_TEXT != node->child->type) - errx(1, "expected boolean line argument"); - + assert(node->child && MDOC_TEXT == node->child->type); if (0 == strcmp("on", node->child->string)) { p->flags &= ~TERMP_NONOSPACE; p->flags &= ~TERMP_NOSPACE; @@ -2211,21 +2114,25 @@ termp_lk_pre(DECL_ARGS) { const struct mdoc_node *n; - if (NULL == (n = node->child)) - errx(1, "expected line argument"); + assert(node->child); + n = node->child; + if (NULL == n->next) { + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK_ANCHOR]); + return(1); + } + p->flags |= ttypes[TTYPE_LINK_ANCHOR]; term_word(p, n->string); - p->flags &= ~ttypes[TTYPE_LINK_ANCHOR]; p->flags |= TERMP_NOSPACE; term_word(p, ":"); + p->flags &= ~ttypes[TTYPE_LINK_ANCHOR]; p->flags |= ttypes[TTYPE_LINK_TEXT]; - for ( ; n; n = n->next) { + for (n = n->next; n; n = n->next) term_word(p, n->string); - } - p->flags &= ~ttypes[TTYPE_LINK_TEXT]; + p->flags &= ~ttypes[TTYPE_LINK_TEXT]; return(0); }