=================================================================== RCS file: /cvs/mandoc/term.c,v retrieving revision 1.10 retrieving revision 1.16 diff -u -p -r1.10 -r1.16 --- mandoc/term.c 2009/02/23 09:33:34 1.10 +++ mandoc/term.c 2009/02/24 16:16:45 1.16 @@ -1,4 +1,4 @@ -/* $Id: term.c,v 1.10 2009/02/23 09:33:34 kristaps Exp $ */ +/* $Id: term.c,v 1.16 2009/02/24 16:16:45 kristaps Exp $ */ /* * Copyright (c) 2009 Kristaps Dzonsons * @@ -30,6 +30,7 @@ */ /* FIXME: indent/tab. */ +/* FIXME: handle nested lists. */ #define TTYPE_PROG 0 #define TTYPE_CMD_FLAG 1 @@ -43,7 +44,11 @@ #define TTYPE_LINK 9 #define TTYPE_SSECTION 10 #define TTYPE_FILE 11 -#define TTYPE_NMAX 12 +#define TTYPE_EMPH 12 +#define TTYPE_CONFIG 13 +#define TTYPE_CMD 14 +#define TTYPE_INCLUDE 15 +#define TTYPE_NMAX 16 /* * These define "styles" for element types, like command arguments or @@ -63,14 +68,19 @@ const int ttypes[TTYPE_NMAX] = { TERMP_UNDERLINE, /* TTYPE_FUNC_ARG */ TERMP_UNDERLINE, /* TTYPE_LINK */ TERMP_BOLD, /* TTYPE_SSECTION */ - TERMP_UNDERLINE /* TTYPE_FILE */ + TERMP_UNDERLINE, /* TTYPE_FILE */ + TERMP_UNDERLINE, /* TTYPE_EMPH */ + TERMP_BOLD, /* TTYPE_CONFIG */ + TERMP_BOLD, /* TTYPE_CMD */ + TERMP_BOLD /* TTYPE_INCLUDE */ }; 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 char *); +static size_t arg_offset(const struct mdoc_arg *); +static size_t arg_width(const struct mdoc_arg *); /* * What follows describes prefix and postfix operations for the abstract @@ -92,18 +102,27 @@ DECL_POST(name); DECL_PREPOST(termp_aq); DECL_PREPOST(termp_ar); +DECL_PREPOST(termp_bd); +DECL_PREPOST(termp_bq); +DECL_PREPOST(termp_cd); +DECL_PREPOST(termp_cm); DECL_PREPOST(termp_d1); DECL_PREPOST(termp_dq); +DECL_PREPOST(termp_em); DECL_PREPOST(termp_fa); DECL_PREPOST(termp_fd); DECL_PREPOST(termp_fl); DECL_PREPOST(termp_fn); +DECL_PREPOST(termp_fo); DECL_PREPOST(termp_ft); +DECL_PREPOST(termp_ic); +DECL_PREPOST(termp_in); DECL_PREPOST(termp_it); DECL_PREPOST(termp_nm); DECL_PREPOST(termp_op); DECL_PREPOST(termp_pa); DECL_PREPOST(termp_pf); +DECL_PREPOST(termp_pq); DECL_PREPOST(termp_qq); DECL_PREPOST(termp_sh); DECL_PREPOST(termp_ss); @@ -112,15 +131,20 @@ DECL_PREPOST(termp_sx); DECL_PREPOST(termp_va); DECL_PREPOST(termp_vt); -DECL_PRE(termp_bd); +DECL_PRE(termp_at); +DECL_PRE(termp_bsx); DECL_PRE(termp_bx); DECL_PRE(termp_ex); +DECL_PRE(termp_fx); DECL_PRE(termp_nd); DECL_PRE(termp_ns); DECL_PRE(termp_nx); DECL_PRE(termp_ox); DECL_PRE(termp_pp); +DECL_PRE(termp_rv); +DECL_PRE(termp_st); DECL_PRE(termp_ud); +DECL_PRE(termp_ux); DECL_PRE(termp_xr); DECL_POST(termp_bl); @@ -135,7 +159,7 @@ const struct termact __termacts[MDOC_MAX] = { { termp_pp_pre, NULL }, /* Pp */ { termp_d1_pre, termp_d1_post }, /* D1 */ { NULL, NULL }, /* Dl */ - { termp_bd_pre, NULL }, /* Bd */ + { termp_bd_pre, termp_bd_post }, /* Bd */ { NULL, NULL }, /* Ed */ { NULL, termp_bl_post }, /* Bl */ { NULL, NULL }, /* El */ @@ -143,8 +167,8 @@ const struct termact __termacts[MDOC_MAX] = { { NULL, NULL }, /* Ad */ { NULL, NULL }, /* An */ { termp_ar_pre, termp_ar_post }, /* Ar */ - { NULL, NULL }, /* Cd */ - { NULL, NULL }, /* Cm */ + { termp_cd_pre, termp_cd_post }, /* Cd */ + { termp_cm_pre, termp_cm_post }, /* Cm */ { NULL, NULL }, /* Dv */ { NULL, NULL }, /* Er */ { NULL, NULL }, /* Ev */ @@ -154,16 +178,16 @@ const struct termact __termacts[MDOC_MAX] = { { termp_fl_pre, termp_fl_post }, /* Fl */ { termp_fn_pre, termp_fn_post }, /* Fn */ { termp_ft_pre, termp_ft_post }, /* Ft */ - { NULL, NULL }, /* Ic */ - { NULL, NULL }, /* In */ + { termp_ic_pre, termp_ic_post }, /* Ic */ + { termp_in_pre, termp_in_post }, /* In */ { NULL, NULL }, /* Li */ { termp_nd_pre, NULL }, /* Nd */ { termp_nm_pre, termp_nm_post }, /* Nm */ { termp_op_pre, termp_op_post }, /* Op */ { NULL, NULL }, /* Ot */ { termp_pa_pre, termp_pa_post }, /* Pa */ - { NULL, NULL }, /* Rv */ - { NULL, NULL }, /* St */ + { termp_rv_pre, NULL }, /* Rv */ + { termp_st_pre, NULL }, /* St */ { termp_va_pre, termp_va_post }, /* Va */ { termp_vt_pre, termp_vt_post }, /* Vt */ { termp_xr_pre, NULL }, /* Xr */ @@ -179,24 +203,24 @@ const struct termact __termacts[MDOC_MAX] = { { NULL, NULL }, /* %T */ { NULL, NULL }, /* %V */ { NULL, NULL }, /* Ac */ - { NULL, NULL }, /* Ao */ + { termp_aq_pre, termp_aq_post }, /* Ao */ { termp_aq_pre, termp_aq_post }, /* Aq */ - { NULL, NULL }, /* At */ + { termp_at_pre, NULL }, /* At */ { NULL, NULL }, /* Bc */ { NULL, NULL }, /* Bf */ - { NULL, NULL }, /* Bo */ - { NULL, NULL }, /* Bq */ - { NULL, NULL }, /* Bsx */ + { 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, NULL }, /* Db */ { NULL, NULL }, /* Dc */ - { NULL, NULL }, /* Do */ + { termp_dq_pre, termp_dq_post }, /* Do */ { termp_dq_pre, termp_dq_post }, /* Dq */ { NULL, NULL }, /* Ec */ { NULL, NULL }, /* Ef */ - { NULL, NULL }, /* Em */ + { termp_em_pre, termp_em_post }, /* Em */ { NULL, NULL }, /* Eo */ - { NULL, NULL }, /* Fx */ + { termp_fx_pre, NULL }, /* Fx */ { NULL, NULL }, /* Ms */ { NULL, NULL }, /* No */ { termp_ns_pre, NULL }, /* Ns */ @@ -204,27 +228,27 @@ const struct termact __termacts[MDOC_MAX] = { { termp_ox_pre, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ { termp_pf_pre, termp_pf_post }, /* Pf */ - { NULL, NULL }, /* Po */ - { NULL, NULL }, /* Pq */ + { termp_pq_pre, termp_pq_post }, /* Po */ + { termp_pq_pre, termp_pq_post }, /* Pq */ { NULL, NULL }, /* Qc */ - { NULL, NULL }, /* Ql */ - { NULL, NULL }, /* Qo */ + { termp_sq_pre, termp_sq_post }, /* Ql */ + { termp_qq_pre, termp_qq_post }, /* Qo */ { termp_qq_pre, termp_qq_post }, /* Qq */ { NULL, NULL }, /* Re */ { NULL, NULL }, /* Rs */ { NULL, NULL }, /* Sc */ - { NULL, NULL }, /* So */ + { termp_sq_pre, termp_sq_post }, /* So */ { termp_sq_pre, termp_sq_post }, /* Sq */ { NULL, NULL }, /* Sm */ { termp_sx_pre, termp_sx_post }, /* Sx */ { NULL, NULL }, /* Sy */ { NULL, NULL }, /* Tn */ - { NULL, NULL }, /* Ux */ + { termp_ux_pre, NULL }, /* Ux */ { NULL, NULL }, /* Xc */ { NULL, NULL }, /* Xo */ - { NULL, NULL }, /* Fo */ + { termp_fo_pre, termp_fo_post }, /* Fo */ { NULL, NULL }, /* Fc */ - { NULL, NULL }, /* Oo */ + { termp_op_pre, termp_op_post }, /* Oo */ { NULL, NULL }, /* Oc */ { NULL, NULL }, /* Bk */ { NULL, NULL }, /* Ek */ @@ -238,15 +262,27 @@ const struct termact *termacts = __termacts; static size_t -arg_offset(const char *v) +arg_width(const struct mdoc_arg *arg) { - if (0 == strcmp(v, "indent")) + + /* TODO */ + assert(*arg->value); + return(strlen(*arg->value)); +} + + +static size_t +arg_offset(const struct mdoc_arg *arg) +{ + + /* TODO */ + assert(*arg->value); + if (0 == strcmp(*arg->value, "indent")) return(INDENT); - if (0 == strcmp(v, "indent-two")) + if (0 == strcmp(*arg->value, "indent-two")) return(INDENT * 2); - /* TODO */ - return(0); + return(strlen(*arg->value)); } @@ -304,7 +340,7 @@ termp_it_post(DECL_ARGS) const struct mdoc_node *n, *it; const struct mdoc_block *bl; int i; - size_t width; + size_t width, offset; /* * This (and termp_it_pre()) are the most complicated functions @@ -335,34 +371,32 @@ termp_it_post(DECL_ARGS) /* If `-tag', adjust our margins accordingly. */ if (arg_hasattr(MDOC_Tag, bl->argc, bl->argv)) { + flushln(p); + + /* FIXME: this should auto-size. */ i = arg_getattr(MDOC_Width, bl->argc, bl->argv); - assert(i >= 0); - assert(1 == bl->argv[i].sz); - width = strlen(*bl->argv[i].value); /* XXX */ + width = i >= 0 ? arg_width(&bl->argv[i]) : 10; + /* FIXME: nesting! Should happen at block. */ + i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); + offset = i >= 0 ? arg_width(&bl->argv[i]) : 0; + if (MDOC_HEAD == node->type) { - flushln(p); - /* FIXME: nested lists. */ p->rmargin = p->maxrmargin; + p->offset -= offset; p->flags &= ~TERMP_NOBREAK; } else { - flushln(p); - p->offset -= width + 1; + p->offset -= width; p->flags &= ~TERMP_NOLPAD; } - return; } if (arg_hasattr(MDOC_Ohang, bl->argc, bl->argv)) { i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); - width = 0; - if (i >= 0) { - assert(1 == bl->argv[i].sz); - width = arg_offset(*bl->argv[i].value); - } + offset = i >= 0 ? arg_offset(&bl->argv[i]) : 0; flushln(p); - p->offset -= width; + p->offset -= offset; return; } } @@ -375,7 +409,7 @@ termp_it_pre(DECL_ARGS) const struct mdoc_node *n, *it; const struct mdoc_block *bl; int i; - size_t width; + size_t width, offset; /* * Also see termp_it_post() for general comments. @@ -416,24 +450,27 @@ termp_it_pre(DECL_ARGS) assert(MDOC_HEAD == node->type || MDOC_BODY == node->type); + /* FIXME: see termp_it_post(). */ + /* If `-tag', adjust our margins accordingly. */ if (arg_hasattr(MDOC_Tag, bl->argc, bl->argv)) { + p->flags |= TERMP_NOSPACE; + i = arg_getattr(MDOC_Width, bl->argc, bl->argv); - assert(i >= 0); /* XXX */ - assert(1 == bl->argv[i].sz); - width = strlen(*bl->argv[i].value); /* XXX */ + width = i >= 0 ? arg_width(&bl->argv[i]) : 10; - /* FIXME: nested lists. */ + i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); + offset = i >= 0 ? arg_offset(&bl->argv[i]) : 0; if (MDOC_HEAD == node->type) { p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_NOSPACE; + p->offset += offset; p->rmargin = p->offset + width; } else { p->flags |= TERMP_NOSPACE; p->flags |= TERMP_NOLPAD; - p->offset += width + 1; + p->offset += width; } return(1); } @@ -441,15 +478,11 @@ termp_it_pre(DECL_ARGS) /* If `-ohang', adjust left-margin. */ if (arg_hasattr(MDOC_Ohang, bl->argc, bl->argv)) { - width = 0; i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); - if (i >= 0) { - assert(1 == bl->argv[i].sz); - width = arg_offset(*bl->argv[i].value); - } + offset = i >= 0 ? arg_offset(&bl->argv[i]) : 0; p->flags |= TERMP_NOSPACE; - p->offset += width; + p->offset += offset; return(1); } @@ -530,6 +563,52 @@ termp_ar_post(DECL_ARGS) /* ARGSUSED */ static int +termp_st_pre(DECL_ARGS) +{ + const char *tp; + + assert(1 == node->data.elem.argc); + + tp = mdoc_st2a(node->data.elem.argv[0].arg); + word(p, tp); + + return(1); +} + + +/* ARGSUSED */ +static int +termp_rv_pre(DECL_ARGS) +{ + int i; + + i = arg_getattr(MDOC_Std, node->data.elem.argc, + node->data.elem.argv); + assert(i >= 0); + + newln(p); + word(p, "The"); + + p->flags |= ttypes[TTYPE_FUNC_NAME]; + word(p, *node->data.elem.argv[i].value); + p->flags &= ~ttypes[TTYPE_FUNC_NAME]; + + word(p, "() function returns the value 0 if successful;"); + word(p, "otherwise the value -1 is returned and the"); + word(p, "global variable"); + + p->flags |= ttypes[TTYPE_VAR_DECL]; + word(p, "errno"); + p->flags &= ~ttypes[TTYPE_VAR_DECL]; + + word(p, "is set to indicate the error."); + + return(1); +} + + +/* ARGSUSED */ +static int termp_ex_pre(DECL_ARGS) { int i; @@ -821,7 +900,6 @@ termp_fn_pre(DECL_ARGS) word(p, node->child->data.text.string); p->flags &= ~ttypes[TTYPE_FUNC_NAME]; - p->flags |= TERMP_NOSPACE; word(p, "("); p->flags |= TERMP_NOSPACE; @@ -830,11 +908,10 @@ termp_fn_pre(DECL_ARGS) p->flags |= ttypes[TTYPE_FUNC_ARG]; word(p, n->data.text.string); p->flags &= ~ttypes[TTYPE_FUNC_ARG]; - if ((n->next)) + if (n->next) word(p, ","); } - p->flags |= TERMP_NOSPACE; word(p, ")"); if (SEC_SYNOPSIS == node->sec) @@ -878,9 +955,28 @@ termp_sx_post(DECL_ARGS) static int termp_fa_pre(DECL_ARGS) { + struct mdoc_node *n; - p->flags |= ttypes[TTYPE_FUNC_ARG]; - return(1); + if (node->parent->tok != MDOC_Fo) { + p->flags |= ttypes[TTYPE_FUNC_ARG]; + return(1); + } + + for (n = node->child; n; n = n->next) { + assert(MDOC_TEXT == n->type); + + p->flags |= ttypes[TTYPE_FUNC_ARG]; + word(p, n->data.text.string); + p->flags &= ~ttypes[TTYPE_FUNC_ARG]; + + if (n->next) + word(p, ","); + } + + if (node->next && node->next->tok == MDOC_Fa) + word(p, ","); + + return(0); } @@ -918,6 +1014,7 @@ termp_bd_pre(DECL_ARGS) { const struct mdoc_block *bl; const struct mdoc_node *n; + int i; if (MDOC_BLOCK == node->type) { vspace(p); @@ -928,6 +1025,13 @@ termp_bd_pre(DECL_ARGS) assert(MDOC_BLOCK == node->parent->type); bl = &node->parent->data.block; + + 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)) return(1); @@ -949,6 +1053,27 @@ termp_bd_pre(DECL_ARGS) /* ARGSUSED */ +static void +termp_bd_post(DECL_ARGS) +{ + int i; + const struct mdoc_block *bl; + + if (MDOC_BODY != node->type) + return; + + assert(MDOC_BLOCK == node->parent->type); + bl = &node->parent->data.block; + + 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]); + } +} + + +/* ARGSUSED */ static int termp_qq_pre(DECL_ARGS) { @@ -975,6 +1100,16 @@ termp_qq_post(DECL_ARGS) /* ARGSUSED */ static int +termp_bsx_pre(DECL_ARGS) +{ + + word(p, "BSDI BSD/OS"); + return(1); +} + + +/* ARGSUSED */ +static int termp_bx_pre(DECL_ARGS) { @@ -995,6 +1130,26 @@ termp_ox_pre(DECL_ARGS) /* ARGSUSED */ static int +termp_ux_pre(DECL_ARGS) +{ + + word(p, "UNIX"); + return(1); +} + + +/* ARGSUSED */ +static int +termp_fx_pre(DECL_ARGS) +{ + + word(p, "FreeBSD"); + return(1); +} + + +/* ARGSUSED */ +static int termp_nx_pre(DECL_ARGS) { @@ -1010,7 +1165,7 @@ termp_sq_pre(DECL_ARGS) if (MDOC_BODY != node->type) return(1); - word(p, "`"); + word(p, "\'"); p->flags |= TERMP_NOSPACE; return(1); } @@ -1101,3 +1256,202 @@ termp_pa_post(DECL_ARGS) p->flags &= ~ttypes[TTYPE_FILE]; } + + +/* ARGSUSED */ +static int +termp_em_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_EMPH]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_em_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_EMPH]; +} + + +/* ARGSUSED */ +static int +termp_cd_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_CONFIG]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_cd_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_CONFIG]; +} + + +/* ARGSUSED */ +static int +termp_cm_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_CMD_FLAG]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_cm_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_CMD_FLAG]; +} + + +/* ARGSUSED */ +static int +termp_ic_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_CMD]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_ic_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_CMD]; +} + + +/* ARGSUSED */ +static int +termp_in_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_INCLUDE]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_in_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_INCLUDE]; +} + + +/* ARGSUSED */ +static int +termp_at_pre(DECL_ARGS) +{ + enum mdoc_att c; + + c = ATT_DEFAULT; + if (node->child) { + assert(MDOC_TEXT == node->child->type); + c = mdoc_atoatt(node->child->data.text.string); + } + + word(p, mdoc_att2a(c)); + return(0); +} + + +/* ARGSUSED */ +static int +termp_bq_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + word(p, "["); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static void +termp_bq_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return; + word(p, "]"); +} + + +/* ARGSUSED */ +static int +termp_pq_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + word(p, "("); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static void +termp_pq_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return; + word(p, ")"); +} + + +/* ARGSUSED */ +static int +termp_fo_pre(DECL_ARGS) +{ + const struct mdoc_node *n; + + if (MDOC_BODY == node->type) { + word(p, "("); + p->flags |= TERMP_NOSPACE; + return(1); + } else if (MDOC_HEAD != node->type) + return(1); + + 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); + } + p->flags &= ~ttypes[TTYPE_FUNC_NAME]; + + return(0); +} + + +/* ARGSUSED */ +static void +termp_fo_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return; + word(p, ")"); + word(p, ";"); + newln(p); +} + +