=================================================================== RCS file: /cvs/mandoc/term.c,v retrieving revision 1.18 retrieving revision 1.105 diff -u -p -r1.18 -r1.105 --- mandoc/term.c 2009/02/25 12:09:20 1.18 +++ mandoc/term.c 2009/10/13 10:57:25 1.105 @@ -1,1418 +1,560 @@ -/* $Id: term.c,v 1.18 2009/02/25 12:09:20 kristaps Exp $ */ +/* $Id: term.c,v 1.105 2009/10/13 10:57:25 kristaps Exp $ */ /* - * Copyright (c) 2009 Kristaps Dzonsons + * Copyright (c) 2008, 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 - * above copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include +#include +#include #include #include +#include "chars.h" #include "term.h" +#include "man.h" +#include "mdoc.h" +#include "main.h" -#define INDENT 4 +/* FIXME: accomodate non-breaking, non-collapsing white-space. */ +/* FIXME: accomodate non-breaking, collapsing white-space. */ -/* - * Performs actions on nodes of the abstract syntax tree. Both pre- and - * post-fix operations are defined here. - */ +static struct termp *term_alloc(enum termenc); +static void term_free(struct termp *); -/* FIXME: indent/tab. */ -/* FIXME: handle nested lists. */ +static void do_escaped(struct termp *, const char **); +static void do_special(struct termp *, + const char *, size_t); +static void do_reserved(struct termp *, + const char *, size_t); +static void buffer(struct termp *, char); +static void encode(struct termp *, char); -#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). - */ - -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) +void * +ascii_alloc(void) { - /* TODO */ - assert(*arg->value); - return(strlen(*arg->value)); + return(term_alloc(TERMENC_ASCII)); } -static size_t -arg_offset(const struct mdoc_arg *arg) +void +terminal_free(void *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)); + term_free((struct termp *)arg); } -static int -arg_hasattr(int arg, size_t argc, const struct mdoc_arg *argv) +static void +term_free(struct termp *p) { - return(-1 != arg_getattr(arg, argc, argv)); -} + if (p->buf) + free(p->buf); + if (p->symtab) + chars_free(p->symtab); - -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); + free(p); } -/* ARGSUSED */ -static int -termp_dq_pre(DECL_ARGS) +static struct termp * +term_alloc(enum termenc enc) { + struct termp *p; - if (MDOC_BODY != node->type) - return(1); - - word(p, "``"); - p->flags |= TERMP_NOSPACE; - return(1); + if (NULL == (p = malloc(sizeof(struct termp)))) + return(NULL); + bzero(p, sizeof(struct termp)); + p->maxrmargin = 78; + p->enc = enc; + return(p); } -/* ARGSUSED */ -static void -termp_dq_post(DECL_ARGS) +/* + * Flush a line of text. A "line" is loosely defined as being something + * that should be followed by a newline, regardless of whether it's + * broken apart by newlines getting there. A line can also be a + * fragment of a columnar list. + * + * Specifically, a line is whatever's in p->buf of length p->col, which + * is zeroed after this function returns. + * + * The usage of termp:flags is as follows: + * + * - TERMP_NOLPAD: when beginning to write the line, don't left-pad the + * offset value. This is useful when doing columnar lists where the + * prior column has right-padded. + * + * - TERMP_NOBREAK: this is the most important and is used when making + * columns. In short: don't print a newline and instead pad to the + * right margin. Used in conjunction with TERMP_NOLPAD. + * + * - TERMP_TWOSPACE: when padding, make sure there are at least two + * space characters of padding. Otherwise, rather break the line. + * + * - TERMP_DANGLE: don't newline when TERMP_NOBREAK is specified and + * the line is overrun, and don't pad-right if it's underrun. + * + * - TERMP_HANG: like TERMP_DANGLE, but doesn't newline when + * overruning, instead save the position and continue at that point + * when the next invocation. + * + * In-line line breaking: + * + * If TERMP_NOBREAK is specified and the line overruns the right + * margin, it will break and pad-right to the right margin after + * writing. If maxrmargin is violated, it will break and continue + * writing from the right-margin, which will lead to the above + * scenario upon exit. + * + * Otherwise, the line will break at the right margin. Extremely long + * lines will cause the system to emit a warning (TODO: hyphenate, if + * possible). + */ +void +term_flushln(struct termp *p) { + int i, j; + size_t vbl, vsz, vis, maxvis, mmax, bp, os; + static int overstep = 0; - 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. + * First, establish the maximum columns of "visible" content. + * This is usually the difference between the right-margin and + * an indentation, but can be, for tagged lists or columns, a + * small set of values. */ - switch (node->type) { - case (MDOC_BODY): - /* FALLTHROUGH */ - case (MDOC_HEAD): - break; - default: - return; - } + assert(p->offset < p->rmargin); + assert((int)(p->rmargin - p->offset) - overstep > 0); - it = node->parent; - assert(MDOC_BLOCK == it->type); - assert(MDOC_It == it->tok); + /* Save the overstep. */ + os = (size_t)overstep; - n = it->parent; - assert(MDOC_BODY == n->type); - assert(MDOC_Bl == n->tok); - n = n->parent; - bl = &n->data.block; + maxvis = /* LINTED */ + p->rmargin - p->offset - overstep; + mmax = /* LINTED */ + p->maxrmargin - p->offset - overstep; - /* If `-tag', adjust our margins accordingly. */ + bp = TERMP_NOBREAK & p->flags ? mmax : maxvis; + vis = 0; + overstep = 0; - 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; - } -} - - -/* 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; - /* - * Also see termp_it_post() for general comments. + * If in the standard case (left-justified), then begin with our + * indentation, otherwise (columns, etc.) just start spitting + * out text. */ - switch (node->type) { - case (MDOC_BODY): - /* FALLTHROUGH */ - case (MDOC_HEAD): - it = node->parent; - break; - case (MDOC_BLOCK): - it = node; - break; - default: - return(1); - } + if ( ! (p->flags & TERMP_NOLPAD)) + /* LINTED */ + for (j = 0; j < (int)p->offset; j++) + putchar(' '); - assert(MDOC_BLOCK == it->type); - assert(MDOC_It == it->tok); + for (i = 0; i < (int)p->col; i++) { + /* + * Count up visible word characters. Control sequences + * (starting with the CSI) aren't counted. A space + * generates a non-printing word, which is valid (the + * space is printed according to regular spacing rules). + */ - n = it->parent; - assert(MDOC_BODY == n->type); - assert(MDOC_Bl == n->tok); - n = n->parent; - bl = &n->data.block; + /* LINTED */ + for (j = i, vsz = 0; j < (int)p->col; j++) { + if (j && ' ' == p->buf[j]) + break; + else if (8 == p->buf[j]) + vsz--; + else + vsz++; + } - /* If `-compact', don't assert vertical space. */ + /* + * Choose the number of blanks to prepend: no blank at the + * beginning of a line, one between words -- but do not + * actually write them yet. + */ + vbl = (size_t)(0 == vis ? 0 : 1); - 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; + /* + * Find out whether we would exceed the right margin. + * If so, break to the next line. (TODO: hyphenate) + * Otherwise, write the chosen number of blanks now. + */ + if (vis && vis + vbl + vsz > bp) { + putchar('\n'); + if (TERMP_NOBREAK & p->flags) { + for (j = 0; j < (int)p->rmargin; j++) + putchar(' '); + vis = p->rmargin - p->offset; + } else { + for (j = 0; j < (int)p->offset; j++) + putchar(' '); + vis = 0; + } + /* Remove the overstep width. */ + bp += os; + os = 0; } else { - p->flags |= TERMP_NOSPACE; - p->flags |= TERMP_NOLPAD; - p->offset += width; + for (j = 0; j < (int)vbl; j++) + putchar(' '); + vis += vbl; } - 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); + /* + * Finally, write out the word. + */ + for ( ; i < (int)p->col; i++) { + if (' ' == p->buf[i]) + break; + putchar(p->buf[i]); + } + vis += vsz; } + p->col = 0; - 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) + if ( ! (TERMP_NOBREAK & p->flags)) { + putchar('\n'); 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; } -} + if (TERMP_HANG & p->flags) { + /* We need one blank after the tag. */ + overstep = /* LINTED */ + vis - maxvis + 1; -/* ARGSUSED */ -static int -termp_xr_pre(DECL_ARGS) -{ - const struct mdoc_node *n; + /* + * Behave exactly the same way as groff: + * If we have overstepped the margin, temporarily move + * it to the right and flag the rest of the line to be + * shorter. + * If we landed right at the margin, be happy. + * If we are one step before the margin, temporarily + * move it one step LEFT and flag the rest of the line + * to be longer. + */ + if (overstep >= -1) { + assert((int)maxvis + overstep >= 0); + /* LINTED */ + maxvis += overstep; + } else + overstep = 0; - n = node->child; - assert(n); + } else if (TERMP_DANGLE & p->flags) + return; - 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); -} - - -/* ARGSUSED */ -static int -termp_vt_pre(DECL_ARGS) -{ - - /* 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; + /* Right-pad. */ + if (maxvis > vis + /* LINTED */ + ((TERMP_TWOSPACE & p->flags) ? 1 : 0)) + for ( ; vis < maxvis; vis++) + putchar(' '); + else { /* ...or newline break. */ + putchar('\n'); + for (i = 0; i < (int)p->rmargin; i++) + putchar(' '); } - return(1); } -/* ARGSUSED */ -static int -termp_op_pre(DECL_ARGS) +/* + * A newline only breaks an existing line; it won't assert vertical + * space. All data in the output buffer is flushed prior to the newline + * assertion. + */ +void +term_newln(struct termp *p) { - switch (node->type) { - case (MDOC_BODY): - word(p, "\\(lB"); - p->flags |= TERMP_NOSPACE; - break; - default: - break; - } - return(1); -} - - -/* 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) + if (0 == p->col) { + p->flags &= ~TERMP_NOLPAD; return; - p->flags |= TERMP_NOSPACE; - word(p, ">"); + } + term_flushln(p); + p->flags &= ~TERMP_NOLPAD; } -/* ARGSUSED */ -static int -termp_ft_pre(DECL_ARGS) +/* + * Asserts a vertical space (a full, empty line-break between lines). + * Note that if used twice, this will cause two blank spaces and so on. + * All data in the output buffer is flushed prior to the newline + * assertion. + */ +void +term_vspace(struct termp *p) { - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_FUNC_TYPE]); - return(1); + term_newln(p); + putchar('\n'); } -/* ARGSUSED */ static void -termp_ft_post(DECL_ARGS) +do_special(struct termp *p, const char *word, size_t len) { + const char *rhs; + size_t sz; + int i; - if (node->sec == SEC_SYNOPSIS) - newln(p); -} + rhs = chars_a2ascii(p->symtab, word, len, &sz); - -/* 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, ","); + if (NULL == rhs) { +#if 0 + fputs("Unknown special character: ", stderr); + for (i = 0; i < (int)len; i++) + fputc(word[i], stderr); + fputc('\n', stderr); +#endif + return; } - - word(p, ")"); - - if (SEC_SYNOPSIS == node->sec) - word(p, ";"); - - return(0); + for (i = 0; i < (int)sz; i++) + encode(p, rhs[i]); } -/* ARGSUSED */ static void -termp_fn_post(DECL_ARGS) +do_reserved(struct termp *p, const char *word, size_t len) { - - if (node->sec == SEC_SYNOPSIS) - vspace(p); - -} - - -/* ARGSUSED */ -static int -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; + const char *rhs; + size_t sz; int i; - if (MDOC_BLOCK == node->type) { - vspace(p); - return(1); - } else if (MDOC_BODY != node->type) - return(1); + rhs = chars_a2res(p->symtab, word, len, &sz); - 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 (NULL == rhs) { +#if 0 + fputs("Unknown reserved word: ", stderr); + for (i = 0; i < (int)len; i++) + fputc(word[i], stderr); + fputc('\n', stderr); +#endif + return; } - - 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); + for (i = 0; i < (int)sz; i++) + encode(p, rhs[i]); } -/* ARGSUSED */ +/* + * Handle an escape sequence: determine its length and pass it to the + * escape-symbol look table. Note that we assume mdoc(3) has validated + * the escape sequence (we assert upon badly-formed escape sequences). + */ static void -termp_bd_post(DECL_ARGS) +do_escaped(struct termp *p, const char **word) { - int i; - const struct mdoc_block *bl; + int j, type; + const char *wp; - if (MDOC_BODY != node->type) - return; + wp = *word; + type = 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 (0 == *(++wp)) { + *word = wp; + return; } -} + if ('(' == *wp) { + wp++; + if (0 == *wp || 0 == *(wp + 1)) { + *word = 0 == *wp ? wp : wp + 1; + return; + } -/* ARGSUSED */ -static int -termp_qq_pre(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return(1); - word(p, "\""); - p->flags |= TERMP_NOSPACE; - return(1); -} - - -/* ARGSUSED */ -static void -termp_qq_post(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) + do_special(p, wp, 2); + *word = ++wp; return; - p->flags |= TERMP_NOSPACE; - word(p, "\""); -} + } else if ('*' == *wp) { + if (0 == *(++wp)) { + *word = wp; + return; + } -/* ARGSUSED */ -static int -termp_bsx_pre(DECL_ARGS) -{ + switch (*wp) { + case ('('): + wp++; + if (0 == *wp || 0 == *(wp + 1)) { + *word = 0 == *wp ? wp : wp + 1; + return; + } - word(p, "BSDI BSD/OS"); - return(1); -} + do_reserved(p, wp, 2); + *word = ++wp; + return; + case ('['): + type = 0; + break; + default: + do_reserved(p, wp, 1); + *word = wp; + return; + } + + } else if ('f' == *wp) { + if (0 == *(++wp)) { + *word = wp; + return; + } + switch (*wp) { + case ('B'): + p->bold++; + break; + case ('I'): + p->under++; + break; + case ('P'): + /* FALLTHROUGH */ + case ('R'): + p->bold = p->under = 0; + break; + default: + break; + } -/* 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 -termp_sq_post(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) + *word = wp; return; - p->flags |= TERMP_NOSPACE; - word(p, "\'"); -} - -/* ARGSUSED */ -static int -termp_pf_pre(DECL_ARGS) -{ - - p->flags |= TERMP_IGNDELIM; - return(1); -} - - -/* ARGSUSED */ -static void -termp_pf_post(DECL_ARGS) -{ - - p->flags &= ~TERMP_IGNDELIM; - p->flags |= TERMP_NOSPACE; -} - - -/* ARGSUSED */ -static int -termp_ss_pre(DECL_ARGS) -{ - - switch (node->type) { - case (MDOC_HEAD): - vspace(p); - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_SSECTION]); - p->offset = INDENT / 2; - break; - default: - break; + } else if ('[' != *wp) { + do_special(p, wp, 1); + *word = wp; + return; } - return(1); -} + wp++; + for (j = 0; *wp && ']' != *wp; wp++, j++) + /* Loop... */ ; - -/* ARGSUSED */ -static void -termp_ss_post(DECL_ARGS) -{ - - switch (node->type) { - case (MDOC_HEAD): - newln(p); - p->offset = INDENT; - break; - default: - break; + if (0 == *wp) { + *word = wp; + return; } -} - -/* ARGSUSED */ -static int -termp_pa_pre(DECL_ARGS) -{ - - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_FILE]); - return(1); + if (type) + do_special(p, wp - j, (size_t)j); + else + do_reserved(p, wp - j, (size_t)j); + *word = wp; } -/* ARGSUSED */ -static int -termp_em_pre(DECL_ARGS) +/* + * Handle pwords, partial words, which may be either a single word or a + * phrase that cannot be broken down (such as a literal string). This + * handles word styling. + */ +void +term_word(struct termp *p, const char *word) { + const char *sv; - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_EMPH]); - return(1); -} + sv = word; + if (word[0] && 0 == word[1]) + switch (word[0]) { + case('.'): + /* FALLTHROUGH */ + case(','): + /* FALLTHROUGH */ + case(';'): + /* FALLTHROUGH */ + case(':'): + /* FALLTHROUGH */ + case('?'): + /* FALLTHROUGH */ + case('!'): + /* FALLTHROUGH */ + case(')'): + /* FALLTHROUGH */ + case(']'): + /* FALLTHROUGH */ + case('}'): + if ( ! (TERMP_IGNDELIM & p->flags)) + p->flags |= TERMP_NOSPACE; + break; + default: + break; + } -/* ARGSUSED */ -static int -termp_cd_pre(DECL_ARGS) -{ + if ( ! (TERMP_NOSPACE & p->flags)) + buffer(p, ' '); - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CONFIG]); - return(1); -} + if ( ! (p->flags & TERMP_NONOSPACE)) + p->flags &= ~TERMP_NOSPACE; + for ( ; *word; word++) + if ('\\' != *word) + encode(p, *word); + else + do_escaped(p, &word); -/* ARGSUSED */ -static int -termp_cm_pre(DECL_ARGS) -{ - - TERMPAIR_SETFLAG(pair, ttypes[TTYPE_CMD_FLAG]); - return(1); + if (sv[0] && 0 == sv[1]) + switch (sv[0]) { + case('('): + /* FALLTHROUGH */ + case('['): + /* FALLTHROUGH */ + case('{'): + p->flags |= TERMP_NOSPACE; + break; + default: + break; + } } -/* ARGSUSED */ -static int -termp_ic_pre(DECL_ARGS) +/* + * Insert a single character into the line-buffer. If the buffer's + * space is exceeded, then allocate more space by doubling the buffer + * size. + */ +static void +buffer(struct termp *p, char c) { + size_t s; - 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); + if (p->col + 1 >= p->maxcols) { + if (0 == p->maxcols) + p->maxcols = 256; + s = p->maxcols * 2; + p->buf = realloc(p->buf, s); + if (NULL == p->buf) + err(1, "realloc"); /* FIXME: shouldn't be here! */ + p->maxcols = s; } - - word(p, mdoc_att2a(c)); - return(0); + p->buf[(int)(p->col)++] = c; } -/* 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) +encode(struct termp *p, char c) { - - 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); + + if (' ' != c) { + if (p->bold) { + buffer(p, c); + buffer(p, 8); + } + if (p->under) { + buffer(p, '_'); + buffer(p, 8); + } } - p->flags &= ~ttypes[TTYPE_FUNC_NAME]; - - return(0); + buffer(p, c); } - - -/* 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); - 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); -} -