=================================================================== RCS file: /cvs/mandoc/term.c,v retrieving revision 1.30 retrieving revision 1.39 diff -u -p -r1.30 -r1.39 --- mandoc/term.c 2009/02/28 21:31:13 1.30 +++ mandoc/term.c 2009/03/04 13:57:35 1.39 @@ -1,4 +1,4 @@ -/* $Id: term.c,v 1.30 2009/02/28 21:31:13 kristaps Exp $ */ +/* $Id: term.c,v 1.39 2009/03/04 13:57:35 kristaps Exp $ */ /* * Copyright (c) 2009 Kristaps Dzonsons * @@ -25,14 +25,11 @@ #include "term.h" -#define INDENT 6 - /* * Performs actions on nodes of the abstract syntax tree. Both pre- and * post-fix operations are defined here. */ -/* FIXME: indent/tab. */ /* FIXME: macro arguments can be escaped. */ #define TTYPE_PROG 0 @@ -53,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 @@ -61,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 */ @@ -79,7 +79,8 @@ 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, @@ -88,6 +89,7 @@ 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_listtype(const struct mdoc_node *); /* * What follows describes prefix and postfix operations for the abstract @@ -134,7 +136,6 @@ DECL_PRE(termp_at); DECL_PRE(termp_bf); DECL_PRE(termp_bsx); DECL_PRE(termp_bt); -DECL_PRE(termp_bx); DECL_PRE(termp_cd); DECL_PRE(termp_cm); DECL_PRE(termp_em); @@ -164,6 +165,7 @@ DECL_PRE(termp_xr); DECL_POST(termp___); DECL_POST(termp_bl); +DECL_POST(termp_bx); const struct termact __termacts[MDOC_MAX] = { { NULL, NULL }, /* \" */ @@ -227,7 +229,7 @@ const struct termact __termacts[MDOC_MAX] = { { termp_bq_pre, termp_bq_post }, /* Bo */ { termp_bq_pre, termp_bq_post }, /* Bq */ { termp_bsx_pre, NULL }, /* Bsx */ - { termp_bx_pre, NULL }, /* Bx */ + { NULL, termp_bx_post }, /* Bx */ { NULL, NULL }, /* Db */ { NULL, NULL }, /* Dc */ { termp_dq_pre, termp_dq_post }, /* Do */ @@ -303,10 +305,48 @@ arg_width(const struct mdoc_arg *arg) } } - return(strlen(*arg->value) + 2); + return(strlen(*arg->value) + 1); } +static int +arg_listtype(const struct mdoc_node *n) +{ + const struct mdoc_block *bl; + int i, len; + + bl = &n->data.block; + len = (int)bl->argc; + + for (i = 0; i < len; 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_Inset): + /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Item): + /* FALLTHROUGH */ + case (MDOC_Ohang): + return(bl->argv[i].arg); + default: + break; + } + + errx(1, "list type not supported"); + /* NOTREACHED */ +} + + static size_t arg_offset(const struct mdoc_arg *arg) { @@ -370,67 +410,45 @@ 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_node *n; 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); - } - - n = it->parent->parent; + n = node->parent->parent; bl = &n->data.block; - 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); - } + newln(p); + if ( ! arg_hasattr(MDOC_Compact, bl->argc, bl->argv)) + if (node->prev || n->prev) + vspace(p); - /* Get our list type. */ + return(1); +} - 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 */ - } - assert(-1 != type); +/* ARGSUSED */ +static int +termp_it_pre(DECL_ARGS) +{ + const struct mdoc_block *bl; + char buf[7]; + int i, type; + size_t width, offset; - /* Save our existing (inherited) margin and offset. */ + if (MDOC_BLOCK == node->type) + return(termp_it_pre_block(p, pair, meta, node)); + /* Get ptr to list block, type, etc. */ + + bl = &node->parent->parent->parent->data.block; + type = arg_listtype(node->parent->parent->parent); + + /* Save parent attributes. */ + pair->offset = p->offset; pair->rmargin = p->rmargin; + pair->flag = p->flags; /* Get list width and offset. */ @@ -440,7 +458,11 @@ termp_it_pre(DECL_ARGS) i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); offset = i >= 0 ? arg_offset(&bl->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): @@ -450,21 +472,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 */ @@ -477,37 +534,23 @@ 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; 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) { @@ -522,18 +565,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); } @@ -541,20 +627,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; - p->flags &= ~TERMP_NORPAD; - } else if (MDOC_BODY == node->type) - p->flags &= ~TERMP_NOLPAD; + p->flags = pair->flag; } @@ -566,9 +663,10 @@ termp_nm_pre(DECL_ARGS) if (SEC_SYNOPSIS == node->sec) newln(p); - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_PROG]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_PROG]); if (NULL == node->child) word(p, meta->name); + return(1); } @@ -578,7 +676,7 @@ static int termp_fl_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD_FLAG]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_FLAG]); word(p, "\\-"); p->flags |= TERMP_NOSPACE; return(1); @@ -590,14 +688,11 @@ static int termp_ar_pre(DECL_ARGS) { - if (node->child) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD_ARG]); - return(1); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_ARG]); + if (NULL == node->child) { + word(p, "file"); + word(p, "..."); } - p->flags |= ttypes[TTYPE_CMD_ARG]; - word(p, "file"); - word(p, "..."); - p->flags &= ~ttypes[TTYPE_CMD_ARG]; return(1); } @@ -764,7 +859,7 @@ termp_vt_pre(DECL_ARGS) { /* FIXME: this can be "type name". */ - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_VAR_DECL]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_VAR_DECL]); return(1); } @@ -788,7 +883,7 @@ termp_fd_pre(DECL_ARGS) * FIXME: this naming is bad. This value is used, in general, * for the #include header or other preprocessor statement. */ - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_FUNC_DECL]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_DECL]); return(1); } @@ -814,7 +909,7 @@ termp_sh_pre(DECL_ARGS) switch (node->type) { case (MDOC_HEAD): vspace(p); - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SECTION]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SECTION]); break; case (MDOC_BODY): p->offset = INDENT; @@ -937,7 +1032,10 @@ static int termp_ft_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_FUNC_TYPE]); + if (SEC_SYNOPSIS == node->sec) + if (node->prev && MDOC_Fo == node->prev->tok) + vspace(p); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_TYPE]); return(1); } @@ -947,7 +1045,7 @@ static void termp_ft_post(DECL_ARGS) { - if (node->sec == SEC_SYNOPSIS) + if (SEC_SYNOPSIS == node->sec) newln(p); } @@ -1004,7 +1102,7 @@ static int termp_sx_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_LINK]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK]); return(1); } @@ -1016,7 +1114,7 @@ termp_fa_pre(DECL_ARGS) struct mdoc_node *n; if (node->parent->tok != MDOC_Fo) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_FUNC_ARG]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_ARG]); return(1); } @@ -1043,7 +1141,7 @@ static int termp_va_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_VAR_DECL]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_VAR_DECL]); return(1); } @@ -1053,8 +1151,8 @@ static int termp_bd_pre(DECL_ARGS) { const struct mdoc_block *bl; - const struct mdoc_node *n; - int i; + const struct mdoc_node *n; + int i, type; if (MDOC_BLOCK == node->type) { if (node->prev) @@ -1063,34 +1161,55 @@ termp_bd_pre(DECL_ARGS) } else if (MDOC_BODY != node->type) return(1); - assert(MDOC_BLOCK == node->parent->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) { + case (MDOC_Ragged): + /* FALLTHROUGH */ + case (MDOC_Filled): + /* FALLTHROUGH */ + case (MDOC_Unfilled): + /* FALLTHROUGH */ + case (MDOC_Literal): + type = bl->argv[i].arg; + i = (int)bl->argc; + break; + default: + errx(1, "display type not supported"); + } + } + assert(-1 != type); + i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); if (-1 != i) { assert(1 == bl->argv[i].sz); p->offset += arg_offset(&bl->argv[i]); } - if ( ! arg_hasattr(MDOC_Literal, bl->argc, bl->argv)) + + switch (type) { + case (MDOC_Literal): + /* FALLTHROUGH */ + case (MDOC_Unfilled): + break; + default: return(1); + } p->flags |= TERMP_LITERAL; for (n = node->child; n; n = n->next) { - assert(MDOC_TEXT == n->type); /* FIXME */ - if ((*n->data.text.string)) { - word(p, n->data.text.string); - flushln(p); - } else - vspace(p); - + if (MDOC_TEXT != n->type) { + warnx("non-text children not yet allowed"); + continue; + } + word(p, n->data.text.string); + flushln(p); } - p->flags &= ~TERMP_LITERAL; return(0); } @@ -1102,7 +1221,11 @@ termp_bd_post(DECL_ARGS) if (MDOC_BODY != node->type) return; - newln(p); + + if ( ! (p->flags & TERMP_LITERAL)) + flushln(p); + + p->flags &= ~TERMP_LITERAL; p->offset = pair->offset; } @@ -1143,12 +1266,13 @@ termp_bsx_pre(DECL_ARGS) /* ARGSUSED */ -static int -termp_bx_pre(DECL_ARGS) +static void +termp_bx_post(DECL_ARGS) { + if (node->child) + p->flags |= TERMP_NOSPACE; word(p, "BSD"); - return(1); } @@ -1245,7 +1369,7 @@ termp_ss_pre(DECL_ARGS) switch (node->type) { case (MDOC_HEAD): vspace(p); - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SSECTION]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SSECTION]); p->offset = INDENT / 2; break; default: @@ -1277,7 +1401,7 @@ static int termp_pa_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_FILE]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FILE]); return(1); } @@ -1287,7 +1411,7 @@ static int termp_em_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); return(1); } @@ -1297,7 +1421,8 @@ static int termp_cd_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CONFIG]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CONFIG]); + newln(p); return(1); } @@ -1307,7 +1432,7 @@ static int termp_cm_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD_FLAG]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_FLAG]); return(1); } @@ -1317,7 +1442,7 @@ static int termp_ic_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD]); return(1); } @@ -1327,12 +1452,10 @@ static int termp_in_pre(DECL_ARGS) { - p->flags |= ttypes[TTYPE_INCLUDE]; + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_INCLUDE]); word(p, "#include"); word(p, "<"); - p->flags &= ~ttypes[TTYPE_INCLUDE]; p->flags |= TERMP_NOSPACE; - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_INCLUDE]); return(1); } @@ -1401,7 +1524,7 @@ termp_pq_pre(DECL_ARGS) if (MDOC_BODY != node->type) return(1); - word(p, "("); + word(p, "\\&("); p->flags |= TERMP_NOSPACE; return(1); } @@ -1475,9 +1598,9 @@ termp_bf_pre(DECL_ARGS) if (NULL == (n = b->head->child)) { if (arg_hasattr(MDOC_Emphasis, b->argc, b->argv)) - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); else if (arg_hasattr(MDOC_Symbolic, b->argc, b->argv)) - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SYMB]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]); return(1); } @@ -1485,9 +1608,9 @@ termp_bf_pre(DECL_ARGS) assert(MDOC_TEXT == n->type); if (0 == strcmp("Em", n->data.text.string)) - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); else if (0 == strcmp("Sy", n->data.text.string)) - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); return(1); } @@ -1498,7 +1621,7 @@ static int termp_sy_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SYMB]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]); return(1); } @@ -1508,7 +1631,7 @@ static int termp_ms_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SYMBOL]); + TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMBOL]); return(1); }