=================================================================== RCS file: /cvs/mandoc/out.c,v retrieving revision 1.34 retrieving revision 1.74 diff -u -p -r1.34 -r1.74 --- mandoc/out.c 2011/01/10 15:31:00 1.34 +++ mandoc/out.c 2018/11/25 19:24:20 1.74 @@ -1,6 +1,7 @@ -/* $Id: out.c,v 1.34 2011/01/10 15:31:00 kristaps Exp $ */ +/* $Id: out.c,v 1.74 2018/11/25 19:24:20 schwarze Exp $ */ /* - * Copyright (c) 2009, 2010 Kristaps Dzonsons + * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2011,2014,2015,2017,2018 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,371 +15,105 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif #include #include #include -#include +#include #include #include #include +#include "mandoc_aux.h" #include "mandoc.h" #include "out.h" static void tblcalc_data(struct rofftbl *, struct roffcol *, - const struct tbl *, const struct tbl_dat *); + const struct tbl_opts *, const struct tbl_dat *, + size_t); static void tblcalc_literal(struct rofftbl *, struct roffcol *, - const struct tbl_dat *); + const struct tbl_dat *, size_t); static void tblcalc_number(struct rofftbl *, struct roffcol *, - const struct tbl *, const struct tbl_dat *); + const struct tbl_opts *, const struct tbl_dat *); -/* - * Convert a `scaling unit' to a consistent form, or fail. Scaling - * units are documented in groff.7, mdoc.7, man.7. + +/* + * Parse the *src string and store a scaling unit into *dst. + * If the string doesn't specify the unit, use the default. + * If no default is specified, fail. + * Return a pointer to the byte after the last byte used, + * or NULL on total failure. */ -int +const char * a2roffsu(const char *src, struct roffsu *dst, enum roffscale def) { - char buf[BUFSIZ], hasd; - int i; - enum roffscale unit; + char *endptr; - if ('\0' == *src) - return(0); + dst->unit = def == SCALE_MAX ? SCALE_BU : def; + dst->scale = strtod(src, &endptr); + if (endptr == src) + return NULL; - i = hasd = 0; - - switch (*src) { - case ('+'): - src++; + switch (*endptr++) { + case 'c': + dst->unit = SCALE_CM; break; - case ('-'): - buf[i++] = *src++; + case 'i': + dst->unit = SCALE_IN; break; - default: + case 'f': + dst->unit = SCALE_FS; break; - } - - if ('\0' == *src) - return(0); - - while (i < BUFSIZ) { - if ( ! isdigit((u_char)*src)) { - if ('.' != *src) - break; - else if (hasd) - break; - else - hasd = 1; - } - buf[i++] = *src++; - } - - if (BUFSIZ == i || (*src && *(src + 1))) - return(0); - - buf[i] = '\0'; - - switch (*src) { - case ('c'): - unit = SCALE_CM; + case 'M': + dst->unit = SCALE_MM; break; - case ('i'): - unit = SCALE_IN; + case 'm': + dst->unit = SCALE_EM; break; - case ('P'): - unit = SCALE_PC; + case 'n': + dst->unit = SCALE_EN; break; - case ('p'): - unit = SCALE_PT; + case 'P': + dst->unit = SCALE_PC; break; - case ('f'): - unit = SCALE_FS; + case 'p': + dst->unit = SCALE_PT; break; - case ('v'): - unit = SCALE_VS; + case 'u': + dst->unit = SCALE_BU; break; - case ('m'): - unit = SCALE_EM; + case 'v': + dst->unit = SCALE_VS; break; - case ('\0'): + default: + endptr--; if (SCALE_MAX == def) - return(0); - unit = SCALE_BU; + return NULL; + dst->unit = def; break; - case ('u'): - unit = SCALE_BU; - break; - case ('M'): - unit = SCALE_MM; - break; - case ('n'): - unit = SCALE_EN; - break; - default: - return(0); } - - /* FIXME: do this in the caller. */ - if ((dst->scale = atof(buf)) < 0) - dst->scale = 0; - dst->unit = unit; - return(1); + return endptr; } - /* - * Correctly writes the time in nroff form, which differs from standard - * form in that a space isn't printed in lieu of the extra %e field for - * single-digit dates. - */ -void -time2a(time_t t, char *dst, size_t sz) -{ - struct tm tm; - char buf[5]; - char *p; - size_t nsz; - - assert(sz > 1); - localtime_r(&t, &tm); - - p = dst; - nsz = 0; - - dst[0] = '\0'; - - if (0 == (nsz = strftime(p, sz, "%B ", &tm))) - return; - - p += (int)nsz; - sz -= nsz; - - if (0 == strftime(buf, sizeof(buf), "%e, ", &tm)) - return; - - nsz = strlcat(p, buf + (' ' == buf[0] ? 1 : 0), sz); - - if (nsz >= sz) - return; - - p += (int)nsz; - sz -= nsz; - - (void)strftime(p, sz, "%Y", &tm); -} - - -int -a2roffdeco(enum roffdeco *d, const char **word, size_t *sz) -{ - int i, j, lim; - char term, c; - const char *wp; - enum roffdeco dd; - - *d = DECO_NONE; - lim = i = 0; - term = '\0'; - wp = *word; - - switch ((c = wp[i++])) { - case ('('): - *d = DECO_SPECIAL; - lim = 2; - break; - case ('F'): - /* FALLTHROUGH */ - case ('f'): - *d = 'F' == c ? DECO_FFONT : DECO_FONT; - - switch (wp[i++]) { - case ('('): - lim = 2; - break; - case ('['): - term = ']'; - break; - case ('3'): - /* FALLTHROUGH */ - case ('B'): - *d = DECO_BOLD; - return(i); - case ('2'): - /* FALLTHROUGH */ - case ('I'): - *d = DECO_ITALIC; - return(i); - case ('P'): - *d = DECO_PREVIOUS; - return(i); - case ('1'): - /* FALLTHROUGH */ - case ('R'): - *d = DECO_ROMAN; - return(i); - default: - i--; - lim = 1; - break; - } - break; - case ('k'): - /* FALLTHROUGH */ - case ('M'): - /* FALLTHROUGH */ - case ('m'): - /* FALLTHROUGH */ - case ('*'): - if ('*' == c) - *d = DECO_RESERVED; - - switch (wp[i++]) { - case ('('): - lim = 2; - break; - case ('['): - term = ']'; - break; - default: - i--; - lim = 1; - break; - } - break; - case ('h'): - /* FALLTHROUGH */ - case ('v'): - /* FALLTHROUGH */ - case ('s'): - j = 0; - if ('+' == wp[i] || '-' == wp[i]) { - i++; - j = 1; - } - - switch (wp[i++]) { - case ('('): - lim = 2; - break; - case ('['): - term = ']'; - break; - case ('\''): - term = '\''; - break; - case ('0'): - j = 1; - /* FALLTHROUGH */ - default: - i--; - lim = 1; - break; - } - - if ('+' == wp[i] || '-' == wp[i]) { - if (j) - return(i); - i++; - } - - /* Handle embedded numerical subexp or escape. */ - - if ('(' == wp[i]) { - while (wp[i] && ')' != wp[i]) - if ('\\' == wp[i++]) { - /* Handle embedded escape. */ - *word = &wp[i]; - i += a2roffdeco(&dd, word, sz); - } - - if (')' == wp[i++]) - break; - - *d = DECO_NONE; - return(i - 1); - } else if ('\\' == wp[i]) { - *word = &wp[++i]; - i += a2roffdeco(&dd, word, sz); - } - - break; - case ('['): - *d = DECO_SPECIAL; - term = ']'; - break; - case ('c'): - *d = DECO_NOSPACE; - return(i); - case ('z'): - *d = DECO_NONE; - if ('\\' == wp[i]) { - *word = &wp[++i]; - return(i + a2roffdeco(&dd, word, sz)); - } else - lim = 1; - break; - case ('o'): - /* FALLTHROUGH */ - case ('w'): - if ('\'' == wp[i++]) { - term = '\''; - break; - } - /* FALLTHROUGH */ - default: - *d = DECO_SSPECIAL; - i--; - lim = 1; - break; - } - - assert(term || lim); - *word = &wp[i]; - - if (term) { - j = i; - while (wp[i] && wp[i] != term) - i++; - if ('\0' == wp[i]) { - *d = DECO_NONE; - return(i); - } - - assert(i >= j); - *sz = (size_t)(i - j); - - return(i + 1); - } - - assert(lim > 0); - *sz = (size_t)lim; - - for (j = 0; wp[i] && j < lim; j++) - i++; - if (j < lim) - *d = DECO_NONE; - - return(i); -} - -/* * Calculate the abstract widths and decimal positions of columns in a * table. This routine allocates the columns structures then runs over * all rows and cells in the table. The function pointers in "tbl" are * used for the actual width calculations. */ void -tblcalc(struct rofftbl *tbl, const struct tbl_span *sp) +tblcalc(struct rofftbl *tbl, const struct tbl_span *sp, + size_t offset, size_t rmargin) { + struct roffsu su; + const struct tbl_opts *opts; const struct tbl_dat *dp; - const struct tbl_head *hp; struct roffcol *col; + size_t ewidth, xwidth; + int hspans; + int icol, maxcol, necol, nxcol, quirkcol; /* * Allocate the master column specifiers. These will hold the @@ -387,180 +122,269 @@ tblcalc(struct rofftbl *tbl, const struct tbl_span *sp */ assert(NULL == tbl->cols); - tbl->cols = calloc(sp->tbl->cols, sizeof(struct roffcol)); + tbl->cols = mandoc_calloc((size_t)sp->opts->cols, + sizeof(struct roffcol)); + opts = sp->opts; - hp = sp->head; - - for ( ; sp; sp = sp->next) { + for (maxcol = -1; sp; sp = sp->next) { if (TBL_SPAN_DATA != sp->pos) continue; + hspans = 1; /* * Account for the data cells in the layout, matching it * to data cells in the data section. */ for (dp = sp->first; dp; dp = dp->next) { - assert(dp->layout); - col = &tbl->cols[dp->layout->head->ident]; - tblcalc_data(tbl, col, sp->tbl, dp); + /* Do not used spanned cells in the calculation. */ + if (0 < --hspans) + continue; + hspans = dp->hspans; + if (1 < hspans) + continue; + icol = dp->layout->col; + while (maxcol < icol) + tbl->cols[++maxcol].spacing = SIZE_MAX; + col = tbl->cols + icol; + col->flags |= dp->layout->flags; + if (dp->layout->flags & TBL_CELL_WIGN) + continue; + if (dp->layout->wstr != NULL && + dp->layout->width == 0 && + a2roffsu(dp->layout->wstr, &su, SCALE_EN) + != NULL) + dp->layout->width = + (*tbl->sulen)(&su, tbl->arg); + if (col->width < dp->layout->width) + col->width = dp->layout->width; + if (dp->layout->spacing != SIZE_MAX && + (col->spacing == SIZE_MAX || + col->spacing < dp->layout->spacing)) + col->spacing = dp->layout->spacing; + tblcalc_data(tbl, col, opts, dp, + dp->block == 0 ? 0 : + dp->layout->width ? dp->layout->width : + rmargin ? (rmargin + sp->opts->cols / 2) + / (sp->opts->cols + 1) : 0); } } - /* - * Calculate width of the spanners. These get one space for a - * vertical line, two for a double-vertical line. + /* + * Align numbers with text. + * Count columns to equalize and columns to maximize. + * Find maximum width of the columns to equalize. + * Find total width of the columns *not* to maximize. */ - for ( ; hp; hp = hp->next) { - col = &tbl->cols[hp->ident]; - switch (hp->pos) { - case (TBL_HEAD_VERT): - col->width = (*tbl->len)(1, tbl->arg); - break; - case (TBL_HEAD_DVERT): - col->width = (*tbl->len)(2, tbl->arg); - break; - default: - break; + necol = nxcol = 0; + ewidth = xwidth = 0; + for (icol = 0; icol <= maxcol; icol++) { + col = tbl->cols + icol; + if (col->width > col->nwidth) + col->decimal += (col->width - col->nwidth) / 2; + else + col->width = col->nwidth; + if (col->spacing == SIZE_MAX || icol == maxcol) + col->spacing = 3; + if (col->flags & TBL_CELL_EQUAL) { + necol++; + if (ewidth < col->width) + ewidth = col->width; } + if (col->flags & TBL_CELL_WMAX) + nxcol++; + else + xwidth += col->width; } + + /* + * Equalize columns, if requested for any of them. + * Update total width of the columns not to maximize. + */ + + if (necol) { + for (icol = 0; icol <= maxcol; icol++) { + col = tbl->cols + icol; + if ( ! (col->flags & TBL_CELL_EQUAL)) + continue; + if (col->width == ewidth) + continue; + if (nxcol && rmargin) + xwidth += ewidth - col->width; + col->width = ewidth; + } + } + + /* + * If there are any columns to maximize, find the total + * available width, deducting 3n margins between columns. + * Distribute the available width evenly. + */ + + if (nxcol && rmargin) { + xwidth += 3*maxcol + + (opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ? + 2 : !!opts->lvert + !!opts->rvert); + if (rmargin <= offset + xwidth) + return; + xwidth = rmargin - offset - xwidth; + + /* + * Emulate a bug in GNU tbl width calculation that + * manifests itself for large numbers of x-columns. + * Emulating it for 5 x-columns gives identical + * behaviour for up to 6 x-columns. + */ + + if (nxcol == 5) { + quirkcol = xwidth % nxcol + 2; + if (quirkcol != 3 && quirkcol != 4) + quirkcol = -1; + } else + quirkcol = -1; + + necol = 0; + ewidth = 0; + for (icol = 0; icol <= maxcol; icol++) { + col = tbl->cols + icol; + if ( ! (col->flags & TBL_CELL_WMAX)) + continue; + col->width = (double)xwidth * ++necol / nxcol + - ewidth + 0.4995; + if (necol == quirkcol) + col->width--; + ewidth += col->width; + } + } } static void tblcalc_data(struct rofftbl *tbl, struct roffcol *col, - const struct tbl *tp, const struct tbl_dat *dp) + const struct tbl_opts *opts, const struct tbl_dat *dp, size_t mw) { size_t sz; /* Branch down into data sub-types. */ switch (dp->layout->pos) { - case (TBL_CELL_HORIZ): - /* FALLTHROUGH */ - case (TBL_CELL_DHORIZ): + case TBL_CELL_HORIZ: + case TBL_CELL_DHORIZ: sz = (*tbl->len)(1, tbl->arg); if (col->width < sz) col->width = sz; break; - case (TBL_CELL_LONG): - /* FALLTHROUGH */ - case (TBL_CELL_CENTRE): - /* FALLTHROUGH */ - case (TBL_CELL_LEFT): - /* FALLTHROUGH */ - case (TBL_CELL_RIGHT): - tblcalc_literal(tbl, col, dp); + case TBL_CELL_LONG: + case TBL_CELL_CENTRE: + case TBL_CELL_LEFT: + case TBL_CELL_RIGHT: + tblcalc_literal(tbl, col, dp, mw); break; - case (TBL_CELL_NUMBER): - tblcalc_number(tbl, col, tp, dp); + case TBL_CELL_NUMBER: + tblcalc_number(tbl, col, opts, dp); break; + case TBL_CELL_DOWN: + break; default: abort(); - /* NOTREACHED */ } } static void tblcalc_literal(struct rofftbl *tbl, struct roffcol *col, - const struct tbl_dat *dp) + const struct tbl_dat *dp, size_t mw) { - size_t sz, bufsz, spsz; - const char *str; + const char *str; /* Beginning of the first line. */ + const char *beg; /* Beginning of the current line. */ + char *end; /* End of the current line. */ + size_t lsz; /* Length of the current line. */ + size_t wsz; /* Length of the current word. */ - /* - * Calculate our width and use the spacing, with a minimum - * spacing dictated by position (centre, e.g,. gets a space on - * either side, while right/left get a single adjacent space). - */ - - bufsz = spsz = 0; - str = dp->string ? dp->string : ""; - sz = (*tbl->slen)(str, tbl->arg); - - /* FIXME: TBL_DATA_HORIZ et al.? */ - - assert(dp->layout); - switch (dp->layout->pos) { - case (TBL_CELL_LONG): - /* FALLTHROUGH */ - case (TBL_CELL_CENTRE): - bufsz = (*tbl->len)(2, tbl->arg); - break; - default: - bufsz = (*tbl->len)(1, tbl->arg); - break; + if (dp->string == NULL || *dp->string == '\0') + return; + str = mw ? mandoc_strdup(dp->string) : dp->string; + lsz = 0; + for (beg = str; beg != NULL && *beg != '\0'; beg = end) { + end = mw ? strchr(beg, ' ') : NULL; + if (end != NULL) { + *end++ = '\0'; + while (*end == ' ') + end++; + } + wsz = (*tbl->slen)(beg, tbl->arg); + if (mw && lsz && lsz + 1 + wsz <= mw) + lsz += 1 + wsz; + else + lsz = wsz; + if (col->width < lsz) + col->width = lsz; } - - if (dp->layout->spacing) { - spsz = (*tbl->len)(dp->layout->spacing, tbl->arg); - bufsz = bufsz > spsz ? bufsz : spsz; - } - - sz += bufsz; - if (col->width < sz) - col->width = sz; + if (mw) + free((void *)str); } static void tblcalc_number(struct rofftbl *tbl, struct roffcol *col, - const struct tbl *tp, const struct tbl_dat *dp) + const struct tbl_opts *opts, const struct tbl_dat *dp) { - int i; - size_t sz, psz, ssz, d; - const char *str; - char *cp; + const char *cp, *lastdigit, *lastpoint; + size_t intsz, totsz; char buf[2]; + if (dp->string == NULL || *dp->string == '\0') + return; + /* - * First calculate number width and decimal place (last + 1 for - * no-decimal numbers). If the stored decimal is subsequent - * ours, make our size longer by that difference - * (right-"shifting"); similarly, if ours is subsequent the - * stored, then extend the stored size by the difference. - * Finally, re-assign the stored values. + * Find the last digit and + * the last decimal point that is adjacent to a digit. + * The alignment indicator "\&" overrides everything. */ - str = dp->string ? dp->string : ""; - sz = (*tbl->slen)(str, tbl->arg); + lastdigit = lastpoint = NULL; + for (cp = dp->string; cp[0] != '\0'; cp++) { + if (cp[0] == '\\' && cp[1] == '&') { + lastdigit = lastpoint = cp; + break; + } else if (cp[0] == opts->decimal && + (isdigit((unsigned char)cp[1]) || + (cp > dp->string && isdigit((unsigned char)cp[-1])))) + lastpoint = cp; + else if (isdigit((unsigned char)cp[0])) + lastdigit = cp; + } - /* FIXME: TBL_DATA_HORIZ et al.? */ + /* Not a number, treat as a literal string. */ - buf[0] = tp->decimal; - buf[1] = '\0'; + totsz = (*tbl->slen)(dp->string, tbl->arg); + if (lastdigit == NULL) { + if (col->width < totsz) + col->width = totsz; + return; + } - psz = (*tbl->slen)(buf, tbl->arg); + /* Measure the width of the integer part. */ - if (NULL != (cp = strrchr(str, tp->decimal))) { - buf[1] = '\0'; - for (ssz = 0, i = 0; cp != &str[i]; i++) { - buf[0] = str[i]; - ssz += (*tbl->slen)(buf, tbl->arg); - } - d = ssz + psz; - } else - d = sz + psz; + if (lastpoint == NULL) + lastpoint = lastdigit + 1; + intsz = 0; + buf[1] = '\0'; + for (cp = dp->string; cp < lastpoint; cp++) { + buf[0] = cp[0]; + intsz += (*tbl->slen)(buf, tbl->arg); + } - /* Padding. */ + /* + * If this number has more integer digits than all numbers + * seen on earlier lines, shift them all to the right. + * If it has fewer, shift this number to the right. + */ - sz += (*tbl->len)(2, tbl->arg); - d += (*tbl->len)(1, tbl->arg); - - /* Adjust the settings for this column. */ - - if (col->decimal > d) { - sz += col->decimal - d; - d = col->decimal; + if (intsz > col->decimal) { + col->nwidth += intsz - col->decimal; + col->decimal = intsz; } else - col->width += d - col->decimal; + totsz += col->decimal - intsz; - if (sz > col->width) - col->width = sz; - if (d > col->decimal) - col->decimal = d; + /* Update the maximum total width seen so far. */ - /* Adjust for stipulated width. */ - - if (col->width < dp->layout->spacing) - col->width = dp->layout->spacing; + if (totsz > col->nwidth) + col->nwidth = totsz; } - -