=================================================================== RCS file: /cvs/mandoc/term.c,v retrieving revision 1.35 retrieving revision 1.47 diff -u -p -r1.35 -r1.47 --- mandoc/term.c 2009/03/02 17:14:46 1.35 +++ mandoc/term.c 2009/03/08 19:38:08 1.47 @@ -1,4 +1,4 @@ -/* $Id: term.c,v 1.35 2009/03/02 17:14:46 kristaps Exp $ */ +/* $Id: term.c,v 1.47 2009/03/08 19:38:08 kristaps Exp $ */ /* * Copyright (c) 2009 Kristaps Dzonsons * @@ -30,7 +30,6 @@ * post-fix operations are defined here. */ -/* FIXME: indent/tab. */ /* FIXME: macro arguments can be escaped. */ #define TTYPE_PROG 0 @@ -51,7 +50,8 @@ #define TTYPE_INCLUDE 15 #define TTYPE_SYMB 16 #define TTYPE_SYMBOL 17 -#define TTYPE_NMAX 18 +#define TTYPE_DIAG 18 +#define TTYPE_NMAX 19 /* * These define "styles" for element types, like command arguments or @@ -59,6 +59,8 @@ * the same thing (like .Ex -std cmd and .Nm cmd). */ +/* TODO: abstract this into mdocterm.c. */ + const int ttypes[TTYPE_NMAX] = { TERMP_BOLD, /* TTYPE_PROG */ TERMP_BOLD, /* TTYPE_CMD_FLAG */ @@ -77,15 +79,15 @@ const int ttypes[TTYPE_NMAX] = { TERMP_BOLD, /* TTYPE_CMD */ TERMP_BOLD, /* TTYPE_INCLUDE */ TERMP_BOLD, /* TTYPE_SYMB */ - TERMP_BOLD /* TTYPE_SYMBOL */ + TERMP_BOLD, /* TTYPE_SYMBOL */ + TERMP_BOLD /* TTYPE_DIAG */ }; -static int arg_hasattr(int, size_t, - const struct mdoc_arg *); -static int arg_getattr(int, size_t, - const struct mdoc_arg *); -static size_t arg_offset(const struct mdoc_arg *); -static size_t arg_width(const struct mdoc_arg *); +static int arg_hasattr(int, const struct mdoc_node *); +static int arg_getattr(int, const struct mdoc_node *); +static size_t arg_offset(const struct mdoc_argv *); +static size_t arg_width(const struct mdoc_argv *); +static int arg_listtype(const struct mdoc_node *); /* * What follows describes prefix and postfix operations for the abstract @@ -118,6 +120,7 @@ DECL_PREPOST(termp_fo); DECL_PREPOST(termp_ft); DECL_PREPOST(termp_in); DECL_PREPOST(termp_it); +DECL_PREPOST(termp_lb); DECL_PREPOST(termp_op); DECL_PREPOST(termp_pf); DECL_PREPOST(termp_pq); @@ -270,13 +273,14 @@ const struct termact __termacts[MDOC_MAX] = { { NULL, NULL }, /* Hf */ { NULL, NULL }, /* Fr */ { termp_ud_pre, NULL }, /* Ud */ + { termp_lb_pre, termp_lb_post }, /* Lb */ }; const struct termact *termacts = __termacts; static size_t -arg_width(const struct mdoc_arg *arg) +arg_width(const struct mdoc_argv *arg) { size_t v; int i, len; @@ -291,7 +295,7 @@ arg_width(const struct mdoc_arg *arg) assert(len > 0); for (i = 0; i < len - 1; i++) - if ( ! isdigit((int)(*arg->value)[i])) + if ( ! isdigit((u_char)(*arg->value)[i])) break; if (i == len - 1) { @@ -305,8 +309,46 @@ arg_width(const struct mdoc_arg *arg) } +static int +arg_listtype(const struct mdoc_node *n) +{ + int i, len; + + assert(MDOC_BLOCK == n->type); + + len = (int)(n->args ? n->args->argc : 0); + + for (i = 0; i < len; i++) + switch (n->args->argv[i].arg) { + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Enum): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Tag): + /* FALLTHROUGH */ + case (MDOC_Inset): + /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Item): + /* FALLTHROUGH */ + case (MDOC_Ohang): + return(n->args->argv[i].arg); + default: + break; + } + + errx(1, "list type not supported"); + /* NOTREACHED */ +} + + static size_t -arg_offset(const struct mdoc_arg *arg) +arg_offset(const struct mdoc_argv *arg) { /* TODO */ @@ -320,20 +362,22 @@ arg_offset(const struct mdoc_arg *arg) static int -arg_hasattr(int arg, size_t argc, const struct mdoc_arg *argv) +arg_hasattr(int arg, const struct mdoc_node *n) { - return(-1 != arg_getattr(arg, argc, argv)); + return(-1 != arg_getattr(arg, n)); } static int -arg_getattr(int arg, size_t argc, const struct mdoc_arg *argv) +arg_getattr(int arg, const struct mdoc_node *n) { int i; - for (i = 0; i < (int)argc; i++) - if (argv[i].arg == arg) + if (NULL == n->args) + return(-1); + for (i = 0; i < (int)n->args->argc; i++) + if (n->args->argv[i].arg == arg) return(i); return(-1); } @@ -368,77 +412,54 @@ termp_dq_post(DECL_ARGS) /* ARGSUSED */ static int -termp_it_pre(DECL_ARGS) +termp_it_pre_block(DECL_ARGS) { - const struct mdoc_node *n, *it; - const struct mdoc_block *bl; - char buf[7], *tp; - int i, type; - size_t width, offset; - switch (node->type) { - case (MDOC_BODY): - /* FALLTHROUGH */ - case (MDOC_HEAD): - it = node->parent; - break; - case (MDOC_BLOCK): - it = node; - break; - default: - return(1); - } + newln(p); + if ( ! arg_hasattr(MDOC_Compact, node->parent->parent)) + if (node->prev || node->parent->parent->prev) + vspace(p); - n = it->parent->parent; - bl = &n->data.block; + return(1); +} - if (MDOC_BLOCK == node->type) { - newln(p); - if ( ! arg_hasattr(MDOC_Compact, bl->argc, bl->argv)) - if (node->prev || n->prev) - vspace(p); - return(1); - } - /* Get our list type. */ +/* ARGSUSED */ +static int +termp_it_pre(DECL_ARGS) +{ + const struct mdoc_node *bl; + char buf[7]; + int i, type; + size_t width, offset; - for (type = -1, i = 0; i < (int)bl->argc; i++) - switch (bl->argv[i].arg) { - case (MDOC_Bullet): - /* FALLTHROUGH */ - case (MDOC_Dash): - /* FALLTHROUGH */ - case (MDOC_Enum): - /* FALLTHROUGH */ - case (MDOC_Hyphen): - /* FALLTHROUGH */ - case (MDOC_Tag): - /* FALLTHROUGH */ - case (MDOC_Ohang): - type = bl->argv[i].arg; - i = (int)bl->argc; - break; - default: - errx(1, "list type not supported"); - /* NOTREACHED */ - } + if (MDOC_BLOCK == node->type) + return(termp_it_pre_block(p, pair, meta, node)); - assert(-1 != type); + /* Get ptr to list block, type, etc. */ - /* Save our existing (inherited) margin and offset. */ + bl = node->parent->parent->parent; + type = arg_listtype(bl); + /* Save parent attributes. */ + pair->offset = p->offset; pair->rmargin = p->rmargin; + pair->flag = p->flags; /* Get list width and offset. */ - i = arg_getattr(MDOC_Width, bl->argc, bl->argv); - width = i >= 0 ? arg_width(&bl->argv[i]) : 0; + i = arg_getattr(MDOC_Width, bl); + width = i >= 0 ? arg_width(&bl->args->argv[i]) : 0; - i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); - offset = i >= 0 ? arg_offset(&bl->argv[i]) : 0; + i = arg_getattr(MDOC_Offset, bl); + offset = i >= 0 ? arg_offset(&bl->args->argv[i]) : 0; - /* Override the width. */ + /* + * List-type can override the width in the case of fixed-head + * values (bullet, dash/hyphen, enum). Tags need a non-zero + * offset. + */ switch (type) { case (MDOC_Bullet): @@ -448,21 +469,56 @@ termp_it_pre(DECL_ARGS) case (MDOC_Enum): /* FALLTHROUGH */ case (MDOC_Hyphen): - width = width > 6 ? width : 6; + width = width > 4 ? width : 4; break; case (MDOC_Tag): - /* FIXME: auto-size. */ - if (0 == width) - errx(1, "need non-zero -width"); + if (width) + break; + errx(1, "need non-zero %s for list type", + mdoc_argnames[MDOC_Width]); + default: break; + } + + /* + * Whitespace control. Inset bodies need an initial space. + */ + + switch (type) { + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Inset): + if (MDOC_BODY == node->type) + p->flags &= ~TERMP_NOSPACE; + else + p->flags |= TERMP_NOSPACE; + break; default: + p->flags |= TERMP_NOSPACE; break; } - /* Word-wrap control. */ + /* + * Style flags. Diagnostic heads need TTYPE_DIAG. + */ - p->flags |= TERMP_NOSPACE; + switch (type) { + case (MDOC_Diag): + if (MDOC_HEAD == node->type) + p->flags |= ttypes[TTYPE_DIAG]; + break; + default: + break; + } + /* + * Pad and break control. This is the tricker part. Lists with + * set right-margins for the head get TERMP_NOBREAK because, if + * they overrun the margin, they wrap to the new margin. + * Correspondingly, the body for these types don't left-pad, as + * the head will pad out to to the right. + */ + switch (type) { case (MDOC_Bullet): /* FALLTHROUGH */ @@ -475,37 +531,27 @@ termp_it_pre(DECL_ARGS) case (MDOC_Tag): if (MDOC_HEAD == node->type) p->flags |= TERMP_NOBREAK; - else if (MDOC_BODY == node->type) + else p->flags |= TERMP_NOLPAD; + if (MDOC_HEAD == node->type && MDOC_Tag == type) + if (NULL == node->next || + NULL == node->next->child) + p->flags |= TERMP_NONOBREAK; break; + case (MDOC_Diag): + if (MDOC_HEAD == node->type) + p->flags |= TERMP_NOBREAK; + break; default: break; } /* - * Get a token to use as the HEAD lead-in. If NULL, we use the - * HEAD child. + * Margin control. Set-head-width lists have their right + * margins shortened. The body for these lists has the offset + * necessarily lengthened. Everybody gets the offset. */ - tp = NULL; - - if (MDOC_HEAD == node->type) { - if (arg_hasattr(MDOC_Bullet, bl->argc, bl->argv)) - tp = "\\[bu]"; - if (arg_hasattr(MDOC_Dash, bl->argc, bl->argv)) - tp = "\\-"; - if (arg_hasattr(MDOC_Enum, bl->argc, bl->argv)) { - (pair->ppair->ppair->count)++; - (void)snprintf(buf, sizeof(buf), "%d.", - pair->ppair->ppair->count); - tp = buf; - } - if (arg_hasattr(MDOC_Hyphen, bl->argc, bl->argv)) - tp = "\\-"; - } - - /* Margin control. */ - p->offset += offset; switch (type) { @@ -520,18 +566,61 @@ termp_it_pre(DECL_ARGS) case (MDOC_Tag): if (MDOC_HEAD == node->type) p->rmargin = p->offset + width; - else if (MDOC_BODY == node->type) + else p->offset += width; - break; + /* FALLTHROUGH */ default: break; } - if (NULL == tp) - return(1); + /* + * The dash, hyphen, bullet and enum lists all have a special + * HEAD character. Print it now. + */ - word(p, tp); - return(0); + if (MDOC_HEAD == node->type) + switch (type) { + case (MDOC_Bullet): + word(p, "\\[bu]"); + break; + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + word(p, "\\-"); + break; + case (MDOC_Enum): + /* TODO: have a wordfmt or something. */ + (pair->ppair->ppair->count)++; + (void)snprintf(buf, sizeof(buf), "%d.", + pair->ppair->ppair->count); + word(p, buf); + break; + default: + break; + } + + /* + * If we're not going to process our header children, indicate + * so here. + */ + + if (MDOC_HEAD == node->type) + switch (type) { + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Item): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Enum): + return(0); + default: + break; + } + + return(1); } @@ -539,19 +628,31 @@ termp_it_pre(DECL_ARGS) static void termp_it_post(DECL_ARGS) { + int type; if (MDOC_BODY != node->type && MDOC_HEAD != node->type) return; - flushln(p); + type = arg_listtype(node->parent->parent->parent); + switch (type) { + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Item): + /* FALLTHROUGH */ + case (MDOC_Inset): + if (MDOC_BODY != node->type) + break; + flushln(p); + break; + default: + flushln(p); + break; + } + p->offset = pair->offset; p->rmargin = pair->rmargin; - - if (MDOC_HEAD == node->type) - p->flags &= ~TERMP_NOBREAK; - else if (MDOC_BODY == node->type) - p->flags &= ~TERMP_NOLPAD; + p->flags = pair->flag; } @@ -589,10 +690,6 @@ termp_ar_pre(DECL_ARGS) { TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_ARG]); - if (NULL == node->child) { - word(p, "file"); - word(p, "..."); - } return(1); } @@ -621,14 +718,15 @@ termp_pp_pre(DECL_ARGS) static int termp_st_pre(DECL_ARGS) { - const char *tp; + const char *cp; - assert(1 == node->data.elem.argc); - - tp = mdoc_st2a(node->data.elem.argv[0].arg); - word(p, tp); - - return(1); + if (node->child) { + if (MDOC_TEXT != node->child->type) + errx(1, "expected text line arguments"); + if ((cp = mdoc_a2st(node->child->string))) + word(p, cp); + } + return(0); } @@ -649,15 +747,16 @@ termp_rv_pre(DECL_ARGS) { int i; - i = arg_getattr(MDOC_Std, node->data.elem.argc, - node->data.elem.argv); - assert(i >= 0); + if (-1 == (i = arg_getattr(MDOC_Std, node))) + errx(1, "expected -std argument"); + if (1 != node->args->argv[i].sz) + errx(1, "expected -std argument"); newln(p); word(p, "The"); p->flags |= ttypes[TTYPE_FUNC_NAME]; - word(p, *node->data.elem.argv[i].value); + word(p, *node->args->argv[i].value); p->flags &= ~ttypes[TTYPE_FUNC_NAME]; word(p, "() function returns the value 0 if successful;"); @@ -680,13 +779,14 @@ termp_ex_pre(DECL_ARGS) { int i; - i = arg_getattr(MDOC_Std, node->data.elem.argc, - node->data.elem.argv); - assert(i >= 0); + if (-1 == (i = arg_getattr(MDOC_Std, node))) + errx(1, "expected -std argument"); + if (1 != node->args->argv[i].sz) + errx(1, "expected -std argument"); word(p, "The"); p->flags |= ttypes[TTYPE_PROG]; - word(p, *node->data.elem.argv[i].value); + word(p, *node->args->argv[i].value); p->flags &= ~ttypes[TTYPE_PROG]; word(p, "utility exits 0 on success, and >0 if an error occurs."); @@ -732,20 +832,22 @@ termp_xr_pre(DECL_ARGS) { const struct mdoc_node *n; - n = node->child; - assert(n); + if (NULL == (n = node->child)) + errx(1, "expected text line argument"); + if (MDOC_TEXT != n->type) + errx(1, "expected text line argument"); - assert(MDOC_TEXT == n->type); - word(p, n->data.text.string); + word(p, n->string); if (NULL == (n = n->next)) return(0); + if (MDOC_TEXT != n->type) + errx(1, "expected text line argument"); - assert(MDOC_TEXT == n->type); p->flags |= TERMP_NOSPACE; word(p, "("); p->flags |= TERMP_NOSPACE; - word(p, n->data.text.string); + word(p, n->string); p->flags |= TERMP_NOSPACE; word(p, ")"); @@ -869,6 +971,36 @@ termp_bt_pre(DECL_ARGS) /* ARGSUSED */ static int +termp_lb_pre(DECL_ARGS) +{ + const char *lb; + + if (NULL == node->child) + errx(1, "expected text line argument"); + if (MDOC_TEXT != node->child->type) + errx(1, "expected text line argument"); + + if ((lb = mdoc_a2lib(node->child->string))) { + word(p, lb); + return(0); + } + + word(p, "library"); + return(1); +} + + +/* ARGSUSED */ +static void +termp_lb_post(DECL_ARGS) +{ + + newln(p); +} + + +/* ARGSUSED */ +static int termp_ud_pre(DECL_ARGS) { @@ -909,7 +1041,7 @@ termp_aq_pre(DECL_ARGS) if (MDOC_BODY != node->type) return(1); - word(p, "<"); + word(p, "\\(la"); p->flags |= TERMP_NOSPACE; return(1); } @@ -923,7 +1055,7 @@ termp_aq_post(DECL_ARGS) if (MDOC_BODY != node->type) return; p->flags |= TERMP_NOSPACE; - word(p, ">"); + word(p, "\\(ra"); } @@ -956,22 +1088,25 @@ termp_fn_pre(DECL_ARGS) { const struct mdoc_node *n; - assert(node->child); - assert(MDOC_TEXT == node->child->type); + if (NULL == node->child) + errx(1, "expected text line arguments"); + if (MDOC_TEXT != node->child->type) + errx(1, "expected text line arguments"); /* FIXME: can be "type funcname" "type varname"... */ p->flags |= ttypes[TTYPE_FUNC_NAME]; - word(p, node->child->data.text.string); + word(p, node->child->string); p->flags &= ~ttypes[TTYPE_FUNC_NAME]; word(p, "("); p->flags |= TERMP_NOSPACE; for (n = node->child->next; n; n = n->next) { - assert(MDOC_TEXT == n->type); + if (MDOC_TEXT != n->type) + errx(1, "expected text line arguments"); p->flags |= ttypes[TTYPE_FUNC_ARG]; - word(p, n->data.text.string); + word(p, n->string); p->flags &= ~ttypes[TTYPE_FUNC_ARG]; if (n->next) word(p, ","); @@ -1019,10 +1154,11 @@ termp_fa_pre(DECL_ARGS) } for (n = node->child; n; n = n->next) { - assert(MDOC_TEXT == n->type); + if (MDOC_TEXT != n->type) + errx(1, "expected text line arguments"); p->flags |= ttypes[TTYPE_FUNC_ARG]; - word(p, n->data.text.string); + word(p, n->string); p->flags &= ~ttypes[TTYPE_FUNC_ARG]; if (n->next) @@ -1050,9 +1186,8 @@ termp_va_pre(DECL_ARGS) static int termp_bd_pre(DECL_ARGS) { - const struct mdoc_block *bl; const struct mdoc_node *n; - int i, type; + int i, type; if (MDOC_BLOCK == node->type) { if (node->prev) @@ -1061,11 +1196,14 @@ termp_bd_pre(DECL_ARGS) } else if (MDOC_BODY != node->type) return(1); + if (NULL == node->parent->args) + errx(1, "missing display type"); + pair->offset = p->offset; - bl = &node->parent->data.block; - for (type = -1, i = 0; i < (int)bl->argc; i++) { - switch (bl->argv[i].arg) { + for (type = -1, i = 0; + i < (int)node->parent->args->argc; i++) { + switch (node->parent->args->argv[i].arg) { case (MDOC_Ragged): /* FALLTHROUGH */ case (MDOC_Filled): @@ -1073,23 +1211,24 @@ termp_bd_pre(DECL_ARGS) case (MDOC_Unfilled): /* FALLTHROUGH */ case (MDOC_Literal): - type = bl->argv[i].arg; - i = (int)bl->argc; + type = node->parent->args->argv[i].arg; + i = (int)node->parent->args->argc; break; default: - errx(1, "display type not supported"); + break; } } - assert(-1 != type); + if (NULL == node->parent->args) + errx(1, "missing display type"); - i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); + i = arg_getattr(MDOC_Offset, node->parent); if (-1 != i) { - assert(1 == bl->argv[i].sz); - p->offset += arg_offset(&bl->argv[i]); + if (1 != node->parent->args->argv[i].sz) + errx(1, "expected single value"); + p->offset += arg_offset(&node->parent->args->argv[i]); } - switch (type) { case (MDOC_Literal): /* FALLTHROUGH */ @@ -1106,7 +1245,7 @@ termp_bd_pre(DECL_ARGS) warnx("non-text children not yet allowed"); continue; } - word(p, n->data.text.string); + word(p, n->string); flushln(p); } @@ -1380,15 +1519,20 @@ termp_in_post(DECL_ARGS) static int termp_at_pre(DECL_ARGS) { - enum mdoc_att c; + const char *att; - c = ATT_DEFAULT; + att = NULL; + if (node->child) { - assert(MDOC_TEXT == node->child->type); - c = mdoc_atoatt(node->child->data.text.string); + if (MDOC_TEXT != node->child->type) + errx(1, "expected text line argument"); + att = mdoc_a2att(node->child->string); } - word(p, mdoc_att2a(c)); + if (NULL == att) + att = "AT&T UNIX"; + + word(p, att); return(0); } @@ -1458,8 +1602,9 @@ termp_fo_pre(DECL_ARGS) p->flags |= ttypes[TTYPE_FUNC_NAME]; for (n = node->child; n; n = n->next) { - assert(MDOC_TEXT == n->type); - word(p, n->data.text.string); + if (MDOC_TEXT != n->type) + errx(1, "expected text line argument"); + word(p, n->string); } p->flags &= ~ttypes[TTYPE_FUNC_NAME]; @@ -1485,31 +1630,27 @@ static int termp_bf_pre(DECL_ARGS) { const struct mdoc_node *n; - const struct mdoc_block *b; - /* XXX - we skip over possible trailing HEAD tokens. */ - - if (MDOC_HEAD == node->type) + if (MDOC_HEAD == node->type) { return(0); - else if (MDOC_BLOCK != node->type) + } else if (MDOC_BLOCK != node->type) return(1); - b = &node->data.block; - - if (NULL == (n = b->head->child)) { - if (arg_hasattr(MDOC_Emphasis, b->argc, b->argv)) + if (NULL == (n = node->head->child)) { + if (arg_hasattr(MDOC_Emphasis, node)) TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); - else if (arg_hasattr(MDOC_Symbolic, b->argc, b->argv)) + else if (arg_hasattr(MDOC_Symbolic, node)) TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]); return(1); } - assert(MDOC_TEXT == n->type); + if (MDOC_TEXT != n->type) + errx(1, "expected text line arguments"); - if (0 == strcmp("Em", n->data.text.string)) + if (0 == strcmp("Em", n->string)) TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); - else if (0 == strcmp("Sy", n->data.text.string)) + else if (0 == strcmp("Sy", n->string)) TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); return(1); @@ -1562,6 +1703,7 @@ static int termp__t_pre(DECL_ARGS) { + /* FIXME: titles are underlined. */ word(p, "\""); p->flags |= TERMP_NOSPACE; return(1); @@ -1574,6 +1716,7 @@ termp__t_post(DECL_ARGS) { p->flags |= TERMP_NOSPACE; + /* FIXME: titles are underlined. */ word(p, "\""); word(p, node->next ? "," : "."); }