=================================================================== RCS file: /cvs/mandoc/out.c,v retrieving revision 1.17 retrieving revision 1.84 diff -u -p -r1.17 -r1.84 --- mandoc/out.c 2010/06/25 19:50:23 1.17 +++ mandoc/out.c 2021/10/17 20:48:28 1.84 @@ -1,6 +1,8 @@ -/* $Id: out.c,v 1.17 2010/06/25 19:50:23 kristaps Exp $ */ +/* $Id: out.c,v 1.84 2021/10/17 20:48:28 schwarze Exp $ */ /* - * Copyright (c) 2009 Kristaps Dzonsons + * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2011, 2014, 2015, 2017, 2018, 2019, 2021 + * 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,384 +16,544 @@ * 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 "tbl.h" #include "out.h" -/* See a2roffdeco(). */ -#define C2LIM(c, l) do { \ - (l) = 1; \ - if ('[' == (c) || '\'' == (c)) \ - (l) = 0; \ - else if ('(' == (c)) \ - (l) = 2; } \ - while (/* CONSTCOND */ 0) +struct tbl_colgroup { + struct tbl_colgroup *next; + size_t wanted; + int startcol; + int endcol; +}; -/* See a2roffdeco(). */ -#define C2TERM(c, t) do { \ - (t) = 0; \ - if ('\'' == (c)) \ - (t) = 1; \ - else if ('[' == (c)) \ - (t) = 2; \ - else if ('(' == (c)) \ - (t) = 3; } \ - while (/* CONSTCOND */ 0) +static size_t tblcalc_data(struct rofftbl *, struct roffcol *, + const struct tbl_opts *, const struct tbl_dat *, + size_t); +static size_t tblcalc_literal(struct rofftbl *, struct roffcol *, + const struct tbl_dat *, size_t); +static size_t tblcalc_number(struct rofftbl *, struct roffcol *, + 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); } - - 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. + * 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 -time2a(time_t t, char *dst, size_t sz) +tblcalc(struct rofftbl *tbl, const struct tbl_span *sp_first, + size_t offset, size_t rmargin) { - struct tm tm; - char buf[5]; - char *p; - size_t nsz; + struct roffsu su; + const struct tbl_opts *opts; + const struct tbl_span *sp; + const struct tbl_dat *dp; + struct roffcol *col; + struct tbl_colgroup *first_group, **gp, *g; + size_t *colwidth; + size_t ewidth, min1, min2, wanted, width, xwidth; + int done, icol, maxcol, necol, nxcol, quirkcol; - assert(sz > 1); - localtime_r(&t, &tm); + /* + * Allocate the master column specifiers. These will hold the + * widths and decimal positions for all cells in the column. It + * must be freed and nullified by the caller. + */ - p = dst; - nsz = 0; + assert(tbl->cols == NULL); + tbl->cols = mandoc_calloc((size_t)sp_first->opts->cols, + sizeof(struct roffcol)); + opts = sp_first->opts; - dst[0] = '\0'; + maxcol = -1; + first_group = NULL; + for (sp = sp_first; sp != NULL; sp = sp->next) { + if (sp->pos != TBL_SPAN_DATA) + continue; - if (0 == (nsz = strftime(p, sz, "%B ", &tm))) - return; + /* + * Account for the data cells in the layout, matching it + * to data cells in the data section. + */ - p += (int)nsz; - sz -= nsz; + for (dp = sp->first; dp != NULL; dp = dp->next) { + icol = dp->layout->col; + while (maxcol < icol + dp->hspans) + tbl->cols[++maxcol].spacing = SIZE_MAX; + col = tbl->cols + icol; + col->flags |= dp->layout->flags; + if (dp->layout->flags & TBL_CELL_WIGN) + continue; - if (0 == strftime(buf, sizeof(buf), "%e, ", &tm)) - return; + /* Handle explicit width specifications. */ - nsz = strlcat(p, buf + (' ' == buf[0] ? 1 : 0), sz); + 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; - if (nsz >= sz) - return; + /* + * Calculate an automatic width. + * Except for spanning cells, apply it. + */ - p += (int)nsz; - sz -= nsz; + width = tblcalc_data(tbl, + dp->hspans == 0 ? col : NULL, + opts, dp, + dp->block == 0 ? 0 : + dp->layout->width ? dp->layout->width : + rmargin ? (rmargin + sp->opts->cols / 2) + / (sp->opts->cols + 1) : 0); + if (dp->hspans == 0) + continue; - (void)strftime(p, sz, "%Y", &tm); -} + /* + * Build a singly linked list + * of all groups of columns joined by spans, + * recording the minimum width for each group. + */ + gp = &first_group; + while (*gp != NULL && ((*gp)->startcol != icol || + (*gp)->endcol != icol + dp->hspans)) + gp = &(*gp)->next; + if (*gp == NULL) { + g = mandoc_malloc(sizeof(*g)); + g->next = *gp; + g->wanted = width; + g->startcol = icol; + g->endcol = icol + dp->hspans; + *gp = g; + } else if ((*gp)->wanted < width) + (*gp)->wanted = width; + } + } -/* - * Returns length of parsed string (the leading "\" should NOT be - * included). This can be zero if the current character is the nil - * terminator. "d" is set to the type of parsed decorator, which may - * have an adjoining "word" of size "sz" (e.g., "(ab" -> "ab", 2). - */ -int -a2roffdeco(enum roffdeco *d, - const char **word, size_t *sz) -{ - int j, term, lim; - char set; - const char *wp, *sp; + /* + * The minimum width of columns explicitly specified + * in the layout is 1n. + */ - *d = DECO_NONE; - wp = *word; + if (maxcol < sp_first->opts->cols - 1) + maxcol = sp_first->opts->cols - 1; + for (icol = 0; icol <= maxcol; icol++) { + col = tbl->cols + icol; + if (col->width < 1) + col->width = 1; - switch ((set = *wp)) { - case ('\0'): - return(0); + /* + * Column spacings are needed for span width + * calculations, so set the default values now. + */ - case ('('): - if ('\0' == *(++wp)) - return(1); - if ('\0' == *(wp + 1)) - return(2); + if (col->spacing == SIZE_MAX || icol == maxcol) + col->spacing = 3; + } - *d = DECO_SPECIAL; - *sz = 2; - *word = wp; - return(3); + /* + * Replace the minimum widths with the missing widths, + * and dismiss groups that are already wide enough. + */ - case ('F'): - /* FALLTHROUGH */ - case ('f'): + gp = &first_group; + while ((g = *gp) != NULL) { + done = 0; + for (icol = g->startcol; icol <= g->endcol; icol++) { + width = tbl->cols[icol].width; + if (icol < g->endcol) + width += tbl->cols[icol].spacing; + if (g->wanted <= width) { + done = 1; + break; + } else + (*gp)->wanted -= width; + } + if (done) { + *gp = g->next; + free(g); + } else + gp = &(*gp)->next; + } + + colwidth = mandoc_reallocarray(NULL, maxcol + 1, sizeof(*colwidth)); + while (first_group != NULL) { + /* - * FIXME: this needs work and consolidation (it should - * follow the sequence that special characters do, for - * one), but isn't a priority at the moment. Note, for - * one, that in reality \fB != \FB, although here we let - * these slip by. + * Rebuild the array of the widths of all columns + * participating in spans that require expansion. */ - switch (*(++wp)) { - case ('\0'): - return(1); - case ('3'): - /* FALLTHROUGH */ - case ('B'): - *d = DECO_BOLD; - return(2); - case ('2'): - /* FALLTHROUGH */ - case ('I'): - *d = DECO_ITALIC; - return(2); - case ('P'): - *d = DECO_PREVIOUS; - return(2); - case ('1'): - /* FALLTHROUGH */ - case ('R'): - *d = DECO_ROMAN; - return(2); - case ('('): - if ('\0' == *(++wp)) - return(2); - if ('\0' == *(wp + 1)) - return(3); - *d = 'F' == set ? DECO_FFONT : DECO_FONT; - *sz = 2; - *word = wp; - return(4); - case ('['): - *word = ++wp; - for (j = 0; *wp && ']' != *wp; wp++, j++) - /* Loop... */ ; + for (icol = 0; icol <= maxcol; icol++) + colwidth[icol] = SIZE_MAX; + for (g = first_group; g != NULL; g = g->next) + for (icol = g->startcol; icol <= g->endcol; icol++) + colwidth[icol] = tbl->cols[icol].width; - if ('\0' == *wp) - return(j + 2); + /* + * Find the smallest and second smallest column width + * among the columns which may need expamsion. + */ - *d = 'F' == set ? DECO_FFONT : DECO_FONT; - *sz = (size_t)j; - return(j + 3); - default: - break; + min1 = min2 = SIZE_MAX; + for (icol = 0; icol <= maxcol; icol++) { + width = colwidth[icol]; + if (min1 > width) { + min2 = min1; + min1 = width; + } else if (min1 < width && min2 > width) + min2 = width; } - *d = 'F' == set ? DECO_FFONT : DECO_FONT; - *sz = 1; - *word = wp; - return(2); + /* + * Find the minimum wanted width + * for any one of the narrowest columns, + * and mark the columns wanting that width. + */ - case ('*'): - switch (*(++wp)) { - case ('\0'): - return(1); + wanted = min2; + for (g = first_group; g != NULL; g = g->next) { + necol = 0; + for (icol = g->startcol; icol <= g->endcol; icol++) + if (colwidth[icol] == min1) + necol++; + if (necol == 0) + continue; + width = min1 + (g->wanted - 1) / necol + 1; + if (width > min2) + width = min2; + if (wanted > width) + wanted = width; + } - case ('('): - if ('\0' == *(++wp)) - return(2); - if ('\0' == *(wp + 1)) - return(3); + /* Record the effect of the widening. */ - *d = DECO_RESERVED; - *sz = 2; - *word = wp; - return(4); + gp = &first_group; + while ((g = *gp) != NULL) { + done = 0; + for (icol = g->startcol; icol <= g->endcol; icol++) { + if (colwidth[icol] != min1) + continue; + if (g->wanted <= wanted - min1) { + tbl->cols[icol].width += g->wanted; + done = 1; + break; + } + tbl->cols[icol].width = wanted; + g->wanted -= wanted - min1; + } + if (done) { + *gp = g->next; + free(g); + } else + gp = &(*gp)->next; + } + } + free(colwidth); - case ('['): - *word = ++wp; - for (j = 0; *wp && ']' != *wp; wp++, j++) - /* Loop... */ ; + /* + * 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. + */ - if ('\0' == *wp) - return(j + 2); + 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; + 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; + } - *d = DECO_RESERVED; - *sz = (size_t)j; - return(j + 3); + /* + * Equalize columns, if requested for any of them. + * Update total width of the columns not to maximize. + */ - default: - break; + 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; } + } - *d = DECO_RESERVED; - *sz = 1; - *word = wp; - return(2); + /* + * If there are any columns to maximize, find the total + * available width, deducting 3n margins between columns. + * Distribute the available width evenly. + */ - case ('s'): - sp = wp; - if ('\0' == *(++wp)) - return(1); + 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; - C2LIM(*wp, lim); - C2TERM(*wp, term); + /* + * 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 (term) - wp++; + if (nxcol == 5) { + quirkcol = xwidth % nxcol + 2; + if (quirkcol != 3 && quirkcol != 4) + quirkcol = -1; + } else + quirkcol = -1; - *word = wp; + 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; + } + } +} - if (*wp == '+' || *wp == '-') - ++wp; +static size_t +tblcalc_data(struct rofftbl *tbl, struct roffcol *col, + const struct tbl_opts *opts, const struct tbl_dat *dp, size_t mw) +{ + size_t sz; - switch (*wp) { - case ('\''): - /* FALLTHROUGH */ - case ('['): - /* FALLTHROUGH */ - case ('('): - if (term) - return((int)(wp - sp)); + /* Branch down into data sub-types. */ - C2LIM(*wp, lim); - C2TERM(*wp, term); - wp++; - break; - default: - break; - } + switch (dp->layout->pos) { + case TBL_CELL_HORIZ: + case TBL_CELL_DHORIZ: + sz = (*tbl->len)(1, tbl->arg); + if (col != NULL && col->width < sz) + col->width = sz; + return sz; + case TBL_CELL_LONG: + case TBL_CELL_CENTRE: + case TBL_CELL_LEFT: + case TBL_CELL_RIGHT: + return tblcalc_literal(tbl, col, dp, mw); + case TBL_CELL_NUMBER: + return tblcalc_number(tbl, col, opts, dp); + case TBL_CELL_DOWN: + return 0; + default: + abort(); + } +} - if ( ! isdigit((u_char)*wp)) - return((int)(wp - sp)); +static size_t +tblcalc_literal(struct rofftbl *tbl, struct roffcol *col, + const struct tbl_dat *dp, size_t mw) +{ + 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. */ + size_t msz; /* Length of the longest line. */ - for (j = 0; isdigit((u_char)*wp); j++) { - if (lim && j >= lim) - break; - ++wp; + if (dp->string == NULL || *dp->string == '\0') + return 0; + str = mw ? mandoc_strdup(dp->string) : dp->string; + msz = 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 (msz < lsz) + msz = lsz; + } + if (mw) + free((void *)str); + if (col != NULL && col->width < msz) + col->width = msz; + return msz; +} - if (term && term < 3) { - if (1 == term && *wp != '\'') - return((int)(wp - sp)); - if (2 == term && *wp != ']') - return((int)(wp - sp)); - ++wp; - } +static size_t +tblcalc_number(struct rofftbl *tbl, struct roffcol *col, + const struct tbl_opts *opts, const struct tbl_dat *dp) +{ + const char *cp, *lastdigit, *lastpoint; + size_t intsz, totsz; + char buf[2]; - *d = DECO_SIZE; - return((int)(wp - sp)); + if (dp->string == NULL || *dp->string == '\0') + return 0; - case ('['): - *word = ++wp; + totsz = (*tbl->slen)(dp->string, tbl->arg); + if (col == NULL) + return totsz; - for (j = 0; *wp && ']' != *wp; wp++, j++) - /* Loop... */ ; + /* + * Find the last digit and + * the last decimal point that is adjacent to a digit. + * The alignment indicator "\&" overrides everything. + */ - if ('\0' == *wp) - return(j + 1); + 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; + } - *d = DECO_SPECIAL; - *sz = (size_t)j; - return(j + 2); + /* Not a number, treat as a literal string. */ - case ('c'): - *d = DECO_NOSPACE; - *sz = 1; - return(1); + if (lastdigit == NULL) { + if (col != NULL && col->width < totsz) + col->width = totsz; + return totsz; + } - default: - break; + /* Measure the width of the integer part. */ + + 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); } - *d = DECO_SPECIAL; - *word = wp; - *sz = 1; - return(1); + /* + * 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. + */ + + if (intsz > col->decimal) { + col->nwidth += intsz - col->decimal; + col->decimal = intsz; + } else + totsz += col->decimal - intsz; + + /* Update the maximum total width seen so far. */ + + if (totsz > col->nwidth) + col->nwidth = totsz; + if (col->nwidth > col->width) + col->width = col->nwidth; + fprintf(stderr, "N=%zu D=%zu I=%zu T=%zu %s\n", + col->nwidth, col->decimal, intsz, totsz, dp->string); + return totsz; }