=================================================================== RCS file: /cvs/mandoc/term.c,v retrieving revision 1.1 retrieving revision 1.18 diff -u -p -r1.1 -r1.18 --- mandoc/term.c 2009/02/20 11:04:23 1.1 +++ mandoc/term.c 2009/02/25 12:09:20 1.18 @@ -1,6 +1,6 @@ -/* $Id: term.c,v 1.1 2009/02/20 11:04:23 kristaps Exp $ */ +/* $Id: term.c,v 1.18 2009/02/25 12:09:20 kristaps Exp $ */ /* - * Copyright (c) 2008 Kristaps Dzonsons + * Copyright (c) 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the @@ -17,344 +17,1402 @@ * PERFORMANCE OF THIS SOFTWARE. */ #include -#include -#include #include -#include #include -#include -#include -#include "mdoc.h" +#include "term.h" +#define INDENT 4 -static int termprint_r(size_t, size_t, - const struct mdoc_node *); -static void termprint_head(size_t, - const struct mdoc_meta *); -static void termprint_tail(size_t, - const struct mdoc_meta *); +/* + * Performs actions on nodes of the abstract syntax tree. Both pre- and + * post-fix operations are defined here. + */ -static char *arch2a(enum mdoc_arch); -static char *vol2a(enum mdoc_vol); -static char *msec2a(enum mdoc_msec); +/* FIXME: indent/tab. */ +/* FIXME: handle nested lists. */ -static size_t ttitle2a(char *, enum mdoc_vol, enum mdoc_msec, - enum mdoc_arch, size_t); +#define TTYPE_PROG 0 +#define TTYPE_CMD_FLAG 1 +#define TTYPE_CMD_ARG 2 +#define TTYPE_SECTION 3 +#define TTYPE_FUNC_DECL 4 +#define TTYPE_VAR_DECL 5 +#define TTYPE_FUNC_TYPE 6 +#define TTYPE_FUNC_NAME 7 +#define TTYPE_FUNC_ARG 8 +#define TTYPE_LINK 9 +#define TTYPE_SSECTION 10 +#define TTYPE_FILE 11 +#define TTYPE_EMPH 12 +#define TTYPE_CONFIG 13 +#define TTYPE_CMD 14 +#define TTYPE_INCLUDE 15 +#define TTYPE_SYMB 16 +#define TTYPE_SYMBOL 17 +#define TTYPE_NMAX 18 +/* + * These define "styles" for element types, like command arguments or + * executable names. This is useful when multiple macros must decorate + * the same thing (like .Ex -std cmd and .Nm cmd). + */ -static char * -arch2a(enum mdoc_arch arch) +const int ttypes[TTYPE_NMAX] = { + TERMP_BOLD, /* TTYPE_PROG */ + TERMP_BOLD, /* TTYPE_CMD_FLAG */ + TERMP_UNDERLINE, /* TTYPE_CMD_ARG */ + TERMP_BOLD, /* TTYPE_SECTION */ + TERMP_BOLD, /* TTYPE_FUNC_DECL */ + TERMP_UNDERLINE, /* TTYPE_VAR_DECL */ + TERMP_UNDERLINE, /* TTYPE_FUNC_TYPE */ + TERMP_BOLD, /* TTYPE_FUNC_NAME */ + TERMP_UNDERLINE, /* TTYPE_FUNC_ARG */ + TERMP_UNDERLINE, /* TTYPE_LINK */ + TERMP_BOLD, /* TTYPE_SSECTION */ + TERMP_UNDERLINE, /* TTYPE_FILE */ + TERMP_UNDERLINE, /* TTYPE_EMPH */ + TERMP_BOLD, /* TTYPE_CONFIG */ + TERMP_BOLD, /* TTYPE_CMD */ + TERMP_BOLD, /* TTYPE_INCLUDE */ + TERMP_BOLD, /* TTYPE_SYMB */ + TERMP_BOLD /* TTYPE_SYMBOL */ +}; + +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 *); + +/* + * What follows describes prefix and postfix operations for the abstract + * syntax tree descent. + */ + +#define DECL_ARGS \ + struct termp *p, \ + struct termpair *pair, \ + const struct mdoc_meta *meta, \ + const struct mdoc_node *node + +#define DECL_PRE(name) \ +static int name##_pre(DECL_ARGS) +#define DECL_POST(name) \ +static void name##_post(DECL_ARGS) +#define DECL_PREPOST(name) \ +DECL_PRE(name); \ +DECL_POST(name); + +DECL_PREPOST(termp_aq); +DECL_PREPOST(termp_bd); +DECL_PREPOST(termp_bq); +DECL_PREPOST(termp_d1); +DECL_PREPOST(termp_dq); +DECL_PREPOST(termp_fd); +DECL_PREPOST(termp_fn); +DECL_PREPOST(termp_fo); +DECL_PREPOST(termp_ft); +DECL_PREPOST(termp_it); +DECL_PREPOST(termp_op); +DECL_PREPOST(termp_pf); +DECL_PREPOST(termp_pq); +DECL_PREPOST(termp_qq); +DECL_PREPOST(termp_sh); +DECL_PREPOST(termp_ss); +DECL_PREPOST(termp_sq); +DECL_PREPOST(termp_vt); + +DECL_PRE(termp_ar); +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); +DECL_PRE(termp_ex); +DECL_PRE(termp_fa); +DECL_PRE(termp_fl); +DECL_PRE(termp_fx); +DECL_PRE(termp_ic); +DECL_PRE(termp_in); +DECL_PRE(termp_ms); +DECL_PRE(termp_nd); +DECL_PRE(termp_nm); +DECL_PRE(termp_ns); +DECL_PRE(termp_nx); +DECL_PRE(termp_ox); +DECL_PRE(termp_pa); +DECL_PRE(termp_pp); +DECL_PRE(termp_rv); +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); + +DECL_POST(termp_bl); + +const struct termact __termacts[MDOC_MAX] = { + { NULL, NULL }, /* \" */ + { NULL, NULL }, /* Dd */ + { NULL, NULL }, /* Dt */ + { NULL, NULL }, /* Os */ + { termp_sh_pre, termp_sh_post }, /* Sh */ + { termp_ss_pre, termp_ss_post }, /* Ss */ + { termp_pp_pre, NULL }, /* Pp */ + { termp_d1_pre, termp_d1_post }, /* D1 */ + { NULL, NULL }, /* Dl */ + { termp_bd_pre, termp_bd_post }, /* Bd */ + { NULL, NULL }, /* Ed */ + { NULL, termp_bl_post }, /* Bl */ + { NULL, NULL }, /* El */ + { termp_it_pre, termp_it_post }, /* It */ + { NULL, NULL }, /* Ad */ + { NULL, NULL }, /* An */ + { termp_ar_pre, NULL }, /* Ar */ + { termp_cd_pre, NULL }, /* Cd */ + { termp_cm_pre, NULL }, /* Cm */ + { NULL, NULL }, /* Dv */ + { NULL, NULL }, /* Er */ + { NULL, NULL }, /* Ev */ + { termp_ex_pre, NULL }, /* Ex */ + { termp_fa_pre, NULL }, /* Fa */ + { termp_fd_pre, termp_fd_post }, /* Fd */ + { termp_fl_pre, NULL }, /* Fl */ + { termp_fn_pre, termp_fn_post }, /* Fn */ + { termp_ft_pre, termp_ft_post }, /* Ft */ + { termp_ic_pre, NULL }, /* Ic */ + { termp_in_pre, NULL }, /* In */ + { NULL, NULL }, /* Li */ + { termp_nd_pre, NULL }, /* Nd */ + { termp_nm_pre, NULL }, /* Nm */ + { termp_op_pre, termp_op_post }, /* Op */ + { NULL, NULL }, /* Ot */ + { termp_pa_pre, NULL }, /* Pa */ + { termp_rv_pre, NULL }, /* Rv */ + { termp_st_pre, NULL }, /* St */ + { termp_va_pre, NULL }, /* Va */ + { termp_vt_pre, termp_vt_post }, /* Vt */ + { termp_xr_pre, NULL }, /* Xr */ + { NULL, NULL }, /* %A */ + { NULL, NULL }, /* %B */ + { NULL, NULL }, /* %D */ + { NULL, NULL }, /* %I */ + { NULL, NULL }, /* %J */ + { NULL, NULL }, /* %N */ + { NULL, NULL }, /* %O */ + { NULL, NULL }, /* %P */ + { NULL, NULL }, /* %R */ + { NULL, NULL }, /* %T */ + { NULL, NULL }, /* %V */ + { NULL, NULL }, /* Ac */ + { termp_aq_pre, termp_aq_post }, /* Ao */ + { termp_aq_pre, termp_aq_post }, /* Aq */ + { termp_at_pre, NULL }, /* At */ + { NULL, NULL }, /* Bc */ + { 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_bx_pre, NULL }, /* Bx */ + { NULL, NULL }, /* Db */ + { NULL, NULL }, /* Dc */ + { termp_dq_pre, termp_dq_post }, /* Do */ + { termp_dq_pre, termp_dq_post }, /* Dq */ + { NULL, NULL }, /* Ec */ + { NULL, NULL }, /* Ef */ + { termp_em_pre, NULL }, /* Em */ + { NULL, NULL }, /* Eo */ + { termp_fx_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 */ + { NULL, NULL }, /* Pc */ + { termp_pf_pre, termp_pf_post }, /* Pf */ + { termp_pq_pre, termp_pq_post }, /* Po */ + { termp_pq_pre, termp_pq_post }, /* Pq */ + { NULL, NULL }, /* Qc */ + { 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 */ + { termp_sq_pre, termp_sq_post }, /* So */ + { termp_sq_pre, termp_sq_post }, /* Sq */ + { NULL, NULL }, /* Sm */ + { termp_sx_pre, NULL }, /* Sx */ + { termp_sy_pre, NULL }, /* Sy */ + { NULL, NULL }, /* Tn */ + { termp_ux_pre, NULL }, /* Ux */ + { NULL, NULL }, /* Xc */ + { NULL, NULL }, /* Xo */ + { termp_fo_pre, termp_fo_post }, /* Fo */ + { NULL, NULL }, /* Fc */ + { termp_op_pre, termp_op_post }, /* Oo */ + { NULL, NULL }, /* Oc */ + { NULL, NULL }, /* Bk */ + { NULL, NULL }, /* Ek */ + { termp_bt_pre, NULL }, /* Bt */ + { NULL, NULL }, /* Hf */ + { NULL, NULL }, /* Fr */ + { termp_ud_pre, NULL }, /* Ud */ +}; + +const struct termact *termacts = __termacts; + + +static size_t +arg_width(const struct mdoc_arg *arg) { - switch (arch) { - case (ARCH_alpha): - return("Alpha"); - case (ARCH_amd64): - return("AMD64"); - case (ARCH_amiga): - return("Amiga"); - case (ARCH_arc): - return("ARC"); - case (ARCH_arm): - return("ARM"); - case (ARCH_armish): - return("ARMISH"); - case (ARCH_aviion): - return("AViion"); - case (ARCH_hp300): - return("HP300"); - case (ARCH_hppa): - return("HPPA"); - case (ARCH_hppa64): - return("HPPA64"); - case (ARCH_i386): - return("i386"); - case (ARCH_landisk): - return("LANDISK"); - case (ARCH_luna88k): - return("Luna88k"); - case (ARCH_mac68k): - return("Mac68k"); - case (ARCH_macppc): - return("MacPPC"); - case (ARCH_mvme68k): - return("MVME68k"); - case (ARCH_mvme88k): - return("MVME88k"); - case (ARCH_mvmeppc): - return("MVMEPPC"); - case (ARCH_pmax): - return("PMAX"); - case (ARCH_sgi): - return("SGI"); - case (ARCH_socppc): - return("SOCPPC"); - case (ARCH_sparc): - return("SPARC"); - case (ARCH_sparc64): - return("SPARC64"); - case (ARCH_sun3): - return("Sun3"); - case (ARCH_vax): - return("VAX"); - case (ARCH_zaurus): - return("Zaurus"); - default: + /* 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(*arg->value, "indent-two")) + return(INDENT * 2); + + return(strlen(*arg->value)); +} + + +static int +arg_hasattr(int arg, size_t argc, const struct mdoc_arg *argv) +{ + + return(-1 != arg_getattr(arg, argc, argv)); +} + + +static int +arg_getattr(int arg, size_t argc, const struct mdoc_arg *argv) +{ + int i; + + for (i = 0; i < (int)argc; i++) + if (argv[i].arg == arg) + return(i); + return(-1); +} + + +/* ARGSUSED */ +static int +termp_dq_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + + word(p, "``"); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static void +termp_dq_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return; + + p->flags |= TERMP_NOSPACE; + word(p, "''"); +} + + +/* ARGSUSED */ +static void +termp_it_post(DECL_ARGS) +{ + const struct mdoc_node *n, *it; + const struct mdoc_block *bl; + int i; + size_t width, offset; + + /* + * This (and termp_it_pre()) are the most complicated functions + * here. They must account for a considerable number of + * switches that completely change the output behaviour, like + * -tag versus -column. Yech. + */ + + switch (node->type) { + case (MDOC_BODY): + /* FALLTHROUGH */ + case (MDOC_HEAD): break; + default: + return; } - return(NULL); + it = node->parent; + assert(MDOC_BLOCK == it->type); + assert(MDOC_It == it->tok); + + n = it->parent; + assert(MDOC_BODY == n->type); + assert(MDOC_Bl == n->tok); + n = n->parent; + bl = &n->data.block; + + /* 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); + 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) { + p->rmargin = p->maxrmargin; + p->offset -= offset; + p->flags &= ~TERMP_NOBREAK; + } else { + p->offset -= width; + p->flags &= ~TERMP_NOLPAD; + } + } + + if (arg_hasattr(MDOC_Ohang, bl->argc, bl->argv)) { + i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); + offset = i >= 0 ? arg_offset(&bl->argv[i]) : 0; + + flushln(p); + p->offset -= offset; + return; + } } -static char * -vol2a(enum mdoc_vol vol) +/* ARGSUSED */ +static int +termp_it_pre(DECL_ARGS) { + const struct mdoc_node *n, *it; + const struct mdoc_block *bl; + int i; + size_t width, offset; - switch (vol) { - case (VOL_AMD): - return("OpenBSD Ancestral Manual Documents"); - case (VOL_IND): - return("OpenBSD Manual Master Index"); - case (VOL_KM): - return("OpenBSD Kernel Manual"); - case (VOL_LOCAL): - return("OpenBSD Local Manual"); - case (VOL_PRM): - return("OpenBSD Programmer's Manual"); - case (VOL_PS1): - return("OpenBSD Programmer's Supplementary Documents"); - case (VOL_SMM): - return("OpenBSD System Manager's Manual"); - case (VOL_URM): - return("OpenBSD Reference Manual"); - case (VOL_USD): - return("OpenBSD User's Supplementary Documents"); + /* + * Also see termp_it_post() for general comments. + */ + + switch (node->type) { + case (MDOC_BODY): + /* FALLTHROUGH */ + case (MDOC_HEAD): + it = node->parent; + break; + case (MDOC_BLOCK): + it = node; + break; default: + return(1); + } + + assert(MDOC_BLOCK == it->type); + assert(MDOC_It == it->tok); + + n = it->parent; + assert(MDOC_BODY == n->type); + assert(MDOC_Bl == n->tok); + n = n->parent; + bl = &n->data.block; + + /* If `-compact', don't assert vertical space. */ + + if (MDOC_BLOCK == node->type) { + if (arg_hasattr(MDOC_Compact, bl->argc, bl->argv)) + newln(p); + else + vspace(p); + return(1); + } + + 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); + width = i >= 0 ? arg_width(&bl->argv[i]) : 10; + + 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->offset += offset; + p->rmargin = p->offset + width; + } else { + p->flags |= TERMP_NOSPACE; + p->flags |= TERMP_NOLPAD; + p->offset += width; + } + return(1); + } + + /* If `-ohang', adjust left-margin. */ + + if (arg_hasattr(MDOC_Ohang, bl->argc, bl->argv)) { + i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); + offset = i >= 0 ? arg_offset(&bl->argv[i]) : 0; + + p->flags |= TERMP_NOSPACE; + p->offset += offset; + return(1); + } + + return(1); +} + + +/* ARGSUSED */ +static int +termp_nm_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_PROG]); + if (NULL == node->child) + word(p, meta->name); + return(1); +} + + +/* ARGSUSED */ +static int +termp_fl_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD_FLAG]); + word(p, "\\-"); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static int +termp_ar_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD_ARG]); + if (NULL == node->child) + word(p, "..."); + return(1); +} + + +/* ARGSUSED */ +static int +termp_ns_pre(DECL_ARGS) +{ + + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static int +termp_pp_pre(DECL_ARGS) +{ + + vspace(p); + return(1); +} + + +/* 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; + + i = arg_getattr(MDOC_Std, node->data.elem.argc, + node->data.elem.argv); + assert(i >= 0); + + word(p, "The"); + p->flags |= ttypes[TTYPE_PROG]; + word(p, *node->data.elem.argv[i].value); + p->flags &= ~ttypes[TTYPE_PROG]; + word(p, "utility exits 0 on success, and >0 if an error occurs."); + + return(1); +} + + +/* ARGSUSED */ +static int +termp_nd_pre(DECL_ARGS) +{ + + word(p, "\\-"); + return(1); +} + + +/* ARGSUSED */ +static void +termp_bl_post(DECL_ARGS) +{ + + if (MDOC_BLOCK == node->type) + newln(p); +} + + +/* ARGSUSED */ +static void +termp_op_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return; + p->flags |= TERMP_NOSPACE; + word(p, "\\(rB"); +} + + +/* ARGSUSED */ +static void +termp_sh_post(DECL_ARGS) +{ + + switch (node->type) { + case (MDOC_HEAD): + newln(p); break; + case (MDOC_BODY): + newln(p); + p->offset = 0; + break; + default: + break; } +} - return(NULL); + +/* ARGSUSED */ +static int +termp_xr_pre(DECL_ARGS) +{ + const struct mdoc_node *n; + + n = node->child; + assert(n); + + assert(MDOC_TEXT == n->type); + word(p, n->data.text.string); + + if (NULL == (n = n->next)) + return(0); + + assert(MDOC_TEXT == n->type); + p->flags |= TERMP_NOSPACE; + word(p, "("); + p->flags |= TERMP_NOSPACE; + word(p, n->data.text.string); + p->flags |= TERMP_NOSPACE; + word(p, ")"); + + return(0); } -static char * -msec2a(enum mdoc_msec msec) +/* ARGSUSED */ +static int +termp_vt_pre(DECL_ARGS) { - switch (msec) { - case(MSEC_1): - return("1"); - case(MSEC_2): - return("2"); - case(MSEC_3): - return("3"); - case(MSEC_3f): - return("3f"); - case(MSEC_3p): - return("3p"); - case(MSEC_4): - return("4"); - case(MSEC_5): - return("5"); - case(MSEC_6): - return("6"); - case(MSEC_7): - return("7"); - case(MSEC_8): - return("8"); - case(MSEC_9): - return("9"); - case(MSEC_X11): - return("X11"); - case(MSEC_X11R6): - return("X11R6"); - case(MSEC_local): - return("local"); - case(MSEC_n): - return("n"); - case(MSEC_unass): - /* FALLTHROUGH */ - case(MSEC_draft): - return("draft"); - case(MSEC_paper): - return("paper"); + /* FIXME: this can be "type name". */ + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_VAR_DECL]); + return(1); +} + + +/* ARGSUSED */ +static void +termp_vt_post(DECL_ARGS) +{ + + if (node->sec == SEC_SYNOPSIS) + vspace(p); +} + + +/* ARGSUSED */ +static int +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]); + return(1); +} + + +/* ARGSUSED */ +static void +termp_fd_post(DECL_ARGS) +{ + + if (node->sec == SEC_SYNOPSIS) + vspace(p); +} + + +/* ARGSUSED */ +static int +termp_sh_pre(DECL_ARGS) +{ + + switch (node->type) { + case (MDOC_HEAD): + vspace(p); + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SECTION]); + break; + case (MDOC_BODY): + p->offset = INDENT; + break; default: break; } - return(NULL); + return(1); } -static size_t -ttitle2a(char *dst, enum mdoc_vol vol, enum mdoc_msec msec, - enum mdoc_arch arch, size_t sz) +/* ARGSUSED */ +static int +termp_op_pre(DECL_ARGS) { - char *p; - size_t ssz; - if (NULL == (p = vol2a(vol))) - switch (msec) { - case (MSEC_1): - /* FALLTHROUGH */ - case (MSEC_6): - /* FALLTHROUGH */ - case (MSEC_7): - p = vol2a(VOL_URM); - break; - case (MSEC_8): - p = vol2a(VOL_SMM); - break; - case (MSEC_2): - /* FALLTHROUGH */ - case (MSEC_3): - /* FALLTHROUGH */ - case (MSEC_4): - /* FALLTHROUGH */ - case (MSEC_5): - p = vol2a(VOL_PRM); - break; - case (MSEC_9): - p = vol2a(VOL_KM); - break; - default: - /* FIXME: capitalise. */ - if (NULL == (p = msec2a(msec))) - p = msec2a(MSEC_local); - break; - } - assert(p); + switch (node->type) { + case (MDOC_BODY): + word(p, "\\(lB"); + p->flags |= TERMP_NOSPACE; + break; + default: + break; + } + return(1); +} - if ((ssz = strlcpy(dst, p, sz)) >= sz) - return(ssz); - if ((p = arch2a(arch))) { - if ((ssz = strlcat(dst, " (", sz)) >= sz) - return(ssz); - if ((ssz = strlcat(dst, p, sz)) >= sz) - return(ssz); - if ((ssz = strlcat(dst, ")", sz)) >= sz) - return(ssz); +/* ARGSUSED */ +static int +termp_bt_pre(DECL_ARGS) +{ + + word(p, "is currently in beta test."); + return(1); +} + + +/* ARGSUSED */ +static int +termp_ud_pre(DECL_ARGS) +{ + + word(p, "currently under development."); + return(1); +} + + +/* ARGSUSED */ +static int +termp_d1_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + newln(p); + p->offset += INDENT; + return(1); +} + + +/* ARGSUSED */ +static void +termp_d1_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return; + newln(p); + p->offset -= INDENT; +} + + +/* ARGSUSED */ +static int +termp_aq_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + word(p, "<"); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static void +termp_aq_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return; + p->flags |= TERMP_NOSPACE; + word(p, ">"); +} + + +/* ARGSUSED */ +static int +termp_ft_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_FUNC_TYPE]); + return(1); +} + + +/* ARGSUSED */ +static void +termp_ft_post(DECL_ARGS) +{ + + if (node->sec == SEC_SYNOPSIS) + newln(p); +} + + +/* ARGSUSED */ +static int +termp_fn_pre(DECL_ARGS) +{ + const struct mdoc_node *n; + + assert(node->child); + assert(MDOC_TEXT == node->child->type); + + /* FIXME: can be "type funcname" "type varname"... */ + + p->flags |= ttypes[TTYPE_FUNC_NAME]; + word(p, node->child->data.text.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); + p->flags |= ttypes[TTYPE_FUNC_ARG]; + word(p, n->data.text.string); + p->flags &= ~ttypes[TTYPE_FUNC_ARG]; + if (n->next) + word(p, ","); } - return(ssz); + word(p, ")"); + + if (SEC_SYNOPSIS == node->sec) + word(p, ";"); + + return(0); } +/* ARGSUSED */ +static void +termp_fn_post(DECL_ARGS) +{ + + if (node->sec == SEC_SYNOPSIS) + vspace(p); + +} + + +/* ARGSUSED */ static int -termprint_r(size_t cols, size_t indent, const struct mdoc_node *node) +termp_sx_pre(DECL_ARGS) { + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_LINK]); return(1); } +/* ARGSUSED */ +static int +termp_fa_pre(DECL_ARGS) +{ + struct mdoc_node *n; + + if (node->parent->tok != MDOC_Fo) { + TERMPAIR_SETFLAG(pair, 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); +} + + +/* ARGSUSED */ +static int +termp_va_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_VAR_DECL]); + return(1); +} + + +/* ARGSUSED */ +static int +termp_bd_pre(DECL_ARGS) +{ + const struct mdoc_block *bl; + const struct mdoc_node *n; + int i; + + if (MDOC_BLOCK == node->type) { + vspace(p); + return(1); + } else if (MDOC_BODY != node->type) + return(1); + + 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); + + 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); + + } + + p->flags &= ~TERMP_LITERAL; + return(0); +} + + +/* ARGSUSED */ static void -termprint_tail(size_t cols, const struct mdoc_meta *meta) +termp_bd_post(DECL_ARGS) { - struct tm *tm; - char *buf, *os; - size_t sz, osz, ssz, i; + int i; + const struct mdoc_block *bl; - if (NULL == (buf = malloc(cols))) - err(1, "malloc"); - if (NULL == (os = malloc(cols))) - err(1, "malloc"); + if (MDOC_BODY != node->type) + return; - tm = localtime(&meta->date); - if (NULL == strftime(buf, cols, "%B %d, %Y", tm)) - err(1, "strftime"); + assert(MDOC_BLOCK == node->parent->type); + bl = &node->parent->data.block; - osz = strlcpy(os, meta->os, cols); + 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]); + } +} - sz = strlen(buf); - ssz = sz + osz + 1; - if (ssz > cols) { - ssz -= cols; - assert(ssz <= osz); - os[osz - ssz] = 0; - ssz = 1; - } else - ssz = cols - ssz + 1; +/* ARGSUSED */ +static int +termp_qq_pre(DECL_ARGS) +{ - printf("%s", os); - for (i = 0; i < ssz; i++) - printf(" "); + if (MDOC_BODY != node->type) + return(1); + word(p, "\""); + p->flags |= TERMP_NOSPACE; + return(1); +} - printf("%s\n", buf); - free(buf); - free(os); +/* ARGSUSED */ +static void +termp_qq_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return; + p->flags |= TERMP_NOSPACE; + word(p, "\""); } +/* ARGSUSED */ +static int +termp_bsx_pre(DECL_ARGS) +{ + + word(p, "BSDI BSD/OS"); + return(1); +} + + +/* ARGSUSED */ +static int +termp_bx_pre(DECL_ARGS) +{ + + word(p, "BSD"); + return(1); +} + + +/* ARGSUSED */ +static int +termp_ox_pre(DECL_ARGS) +{ + + word(p, "OpenBSD"); + return(1); +} + + +/* 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) +{ + + word(p, "NetBSD"); + return(1); +} + + +/* ARGSUSED */ +static int +termp_sq_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + word(p, "\'"); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ static void -termprint_head(size_t cols, const struct mdoc_meta *meta) +termp_sq_post(DECL_ARGS) { - char *msec, *buf, *title; - size_t ssz, tsz, ttsz, i; - if (NULL == (buf = malloc(cols))) - err(1, "malloc"); - if (NULL == (title = malloc(cols))) - err(1, "malloc"); + if (MDOC_BODY != node->type) + return; + p->flags |= TERMP_NOSPACE; + word(p, "\'"); +} - /* Format the manual page header. */ - tsz = ttitle2a(buf, meta->vol, meta->msec, meta->arch, cols); - ttsz = strlcpy(title, meta->title, cols); +/* ARGSUSED */ +static int +termp_pf_pre(DECL_ARGS) +{ - if (NULL == (msec = msec2a(meta->msec))) - msec = ""; + p->flags |= TERMP_IGNDELIM; + return(1); +} - ssz = (2 * (ttsz + 2 + strlen(msec))) + tsz + 2; - if (ssz > cols) { - if ((ssz -= cols) % 2) - ssz++; - ssz /= 2; - - assert(ssz <= ttsz); - title[ttsz - ssz] = 0; - ssz = 1; - } else - ssz = ((cols - ssz) / 2) + 1; +/* ARGSUSED */ +static void +termp_pf_post(DECL_ARGS) +{ - printf("%s(%s)", title, msec); + p->flags &= ~TERMP_IGNDELIM; + p->flags |= TERMP_NOSPACE; +} - for (i = 0; i < ssz; i++) - printf(" "); - printf("%s", buf); +/* ARGSUSED */ +static int +termp_ss_pre(DECL_ARGS) +{ - for (i = 0; i < ssz; i++) - printf(" "); + switch (node->type) { + case (MDOC_HEAD): + vspace(p); + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SSECTION]); + p->offset = INDENT / 2; + break; + default: + break; + } - printf("%s(%s)\n\n", title, msec); + return(1); +} - free(title); - free(buf); + +/* ARGSUSED */ +static void +termp_ss_post(DECL_ARGS) +{ + + switch (node->type) { + case (MDOC_HEAD): + newln(p); + p->offset = INDENT; + break; + default: + break; + } } -int -termprint(const struct mdoc_node *node, - const struct mdoc_meta *meta) +/* ARGSUSED */ +static int +termp_pa_pre(DECL_ARGS) { - size_t cols; - if (ERR == setupterm(NULL, STDOUT_FILENO, NULL)) - return(0); + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_FILE]); + return(1); +} - cols = columns < 60 ? 60 : (size_t)columns; - termprint_head(cols, meta); - if ( ! termprint_r(cols, 0, node)) +/* ARGSUSED */ +static int +termp_em_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); + return(1); +} + + +/* ARGSUSED */ +static int +termp_cd_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CONFIG]); + return(1); +} + + +/* ARGSUSED */ +static int +termp_cm_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD_FLAG]); + return(1); +} + + +/* ARGSUSED */ +static int +termp_ic_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD]); + return(1); +} + + +/* ARGSUSED */ +static int +termp_in_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_INCLUDE]); + return(1); +} + + +/* 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); + + /* XXX - groff shows only first parameter */ + + 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); +} + + +/* ARGSUSED */ +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) return(0); - termprint_tail(cols, meta); + 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)) + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); + else if (arg_hasattr(MDOC_Symbolic, b->argc, b->argv)) + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SYMB]); + + return(1); + } + + assert(MDOC_TEXT == n->type); + + if (0 == strcmp("Em", n->data.text.string)) + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); + else if (0 == strcmp("Sy", n->data.text.string)) + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); + return(1); } + +/* ARGSUSED */ +static int +termp_sy_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SYMB]); + return(1); +} + + +/* ARGSUSED */ +static int +termp_ms_pre(DECL_ARGS) +{ + + TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SYMBOL]); + return(1); +}