1 /* $Id: out.c,v 1.82 2021/09/07 17:07:58 schwarze Exp $ */
3 * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2011, 2014, 2015, 2017, 2018, 2019, 2021
5 * Ingo Schwarze <schwarze@openbsd.org>
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <sys/types.h>
31 #include "mandoc_aux.h"
37 struct tbl_colgroup *next;
43 static size_t tblcalc_data(struct rofftbl *, struct roffcol *,
44 const struct tbl_opts *, const struct tbl_dat *,
46 static size_t tblcalc_literal(struct rofftbl *, struct roffcol *,
47 const struct tbl_dat *, size_t);
48 static size_t tblcalc_number(struct rofftbl *, struct roffcol *,
49 const struct tbl_opts *, const struct tbl_dat *);
53 * Parse the *src string and store a scaling unit into *dst.
54 * If the string doesn't specify the unit, use the default.
55 * If no default is specified, fail.
56 * Return a pointer to the byte after the last byte used,
57 * or NULL on total failure.
60 a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
64 dst->unit = def == SCALE_MAX ? SCALE_BU : def;
65 dst->scale = strtod(src, &endptr);
102 if (SCALE_MAX == def)
111 * Calculate the abstract widths and decimal positions of columns in a
112 * table. This routine allocates the columns structures then runs over
113 * all rows and cells in the table. The function pointers in "tbl" are
114 * used for the actual width calculations.
117 tblcalc(struct rofftbl *tbl, const struct tbl_span *sp_first,
118 size_t offset, size_t rmargin)
121 const struct tbl_opts *opts;
122 const struct tbl_span *sp;
123 const struct tbl_dat *dp;
125 struct tbl_colgroup *first_group, **gp, *g;
126 size_t ewidth, min1, min2, wanted, width, xwidth;
127 int done, icol, maxcol, necol, nxcol, quirkcol;
130 * Allocate the master column specifiers. These will hold the
131 * widths and decimal positions for all cells in the column. It
132 * must be freed and nullified by the caller.
135 assert(tbl->cols == NULL);
136 tbl->cols = mandoc_calloc((size_t)sp_first->opts->cols,
137 sizeof(struct roffcol));
138 opts = sp_first->opts;
142 for (sp = sp_first; sp != NULL; sp = sp->next) {
143 if (sp->pos != TBL_SPAN_DATA)
147 * Account for the data cells in the layout, matching it
148 * to data cells in the data section.
152 for (dp = sp->first; dp != NULL; dp = dp->next) {
153 icol = dp->layout->col;
154 while (maxcol < icol + dp->hspans)
155 tbl->cols[++maxcol].spacing = SIZE_MAX;
156 col = tbl->cols + icol;
157 col->flags |= dp->layout->flags;
158 if (dp->layout->flags & TBL_CELL_WIGN)
161 /* Handle explicit width specifications. */
163 if (dp->layout->wstr != NULL &&
164 dp->layout->width == 0 &&
165 a2roffsu(dp->layout->wstr, &su, SCALE_EN)
168 (*tbl->sulen)(&su, tbl->arg);
169 if (col->width < dp->layout->width)
170 col->width = dp->layout->width;
171 if (dp->layout->spacing != SIZE_MAX &&
172 (col->spacing == SIZE_MAX ||
173 col->spacing < dp->layout->spacing))
174 col->spacing = dp->layout->spacing;
177 * Calculate an automatic width.
178 * Except for spanning cells, apply it.
181 width = tblcalc_data(tbl,
182 dp->hspans == 0 ? col : NULL,
185 dp->layout->width ? dp->layout->width :
186 rmargin ? (rmargin + sp->opts->cols / 2)
187 / (sp->opts->cols + 1) : 0);
192 * Build an ordered, singly linked list
193 * of all groups of columns joined by spans,
194 * recording the minimum width for each group.
197 while (*gp != NULL && ((*gp)->startcol < icol ||
198 (*gp)->endcol < icol + dp->hspans))
200 if (*gp == NULL || (*gp)->startcol > icol ||
201 (*gp)->endcol > icol + dp->hspans) {
202 g = mandoc_malloc(sizeof(*g));
206 g->endcol = icol + dp->hspans;
208 } else if ((*gp)->wanted < width)
209 (*gp)->wanted = width;
214 * The minimum width of columns explicitly specified
215 * in the layout is 1n.
218 if (maxcol < sp_first->opts->cols - 1)
219 maxcol = sp_first->opts->cols - 1;
220 for (icol = 0; icol <= maxcol; icol++) {
221 col = tbl->cols + icol;
226 * Column spacings are needed for span width
227 * calculations, so set the default values now.
230 if (col->spacing == SIZE_MAX || icol == maxcol)
235 * Replace the minimum widths with the missing widths,
236 * and dismiss groups that are already wide enough.
240 while ((g = *gp) != NULL) {
242 for (icol = g->startcol; icol <= g->endcol; icol++) {
243 width = tbl->cols[icol].width;
244 if (icol < g->endcol)
245 width += tbl->cols[icol].spacing;
246 if (g->wanted <= width) {
250 (*gp)->wanted -= width;
259 while (first_group != NULL) {
262 * Find the smallest and second smallest column width
263 * among the columns which may need expamsion.
266 min1 = min2 = SIZE_MAX;
267 for (icol = 0; icol <= maxcol; icol++) {
268 width = tbl->cols[icol].width;
272 } else if (min1 < width && min2 > width)
277 * Find the minimum wanted width
278 * for any one of the narrowest columns,
279 * and mark the columns wanting that width.
283 for (g = first_group; g != NULL; g = g->next) {
285 for (icol = g->startcol; icol <= g->endcol; icol++)
286 if (tbl->cols[icol].width == min1)
290 width = min1 + (g->wanted - 1) / necol + 1;
297 /* Record the effect of the widening. */
300 while ((g = *gp) != NULL) {
302 for (icol = g->startcol; icol <= g->endcol; icol++) {
303 if (tbl->cols[icol].width != min1)
305 if (g->wanted <= wanted - min1) {
306 tbl->cols[icol].width += g->wanted;
310 tbl->cols[icol].width = wanted;
311 g->wanted -= wanted - min1;
322 * Align numbers with text.
323 * Count columns to equalize and columns to maximize.
324 * Find maximum width of the columns to equalize.
325 * Find total width of the columns *not* to maximize.
330 for (icol = 0; icol <= maxcol; icol++) {
331 col = tbl->cols + icol;
332 if (col->width > col->nwidth)
333 col->decimal += (col->width - col->nwidth) / 2;
334 if (col->flags & TBL_CELL_EQUAL) {
336 if (ewidth < col->width)
339 if (col->flags & TBL_CELL_WMAX)
342 xwidth += col->width;
346 * Equalize columns, if requested for any of them.
347 * Update total width of the columns not to maximize.
351 for (icol = 0; icol <= maxcol; icol++) {
352 col = tbl->cols + icol;
353 if ( ! (col->flags & TBL_CELL_EQUAL))
355 if (col->width == ewidth)
357 if (nxcol && rmargin)
358 xwidth += ewidth - col->width;
364 * If there are any columns to maximize, find the total
365 * available width, deducting 3n margins between columns.
366 * Distribute the available width evenly.
369 if (nxcol && rmargin) {
371 (opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ?
372 2 : !!opts->lvert + !!opts->rvert);
373 if (rmargin <= offset + xwidth)
375 xwidth = rmargin - offset - xwidth;
378 * Emulate a bug in GNU tbl width calculation that
379 * manifests itself for large numbers of x-columns.
380 * Emulating it for 5 x-columns gives identical
381 * behaviour for up to 6 x-columns.
385 quirkcol = xwidth % nxcol + 2;
386 if (quirkcol != 3 && quirkcol != 4)
393 for (icol = 0; icol <= maxcol; icol++) {
394 col = tbl->cols + icol;
395 if ( ! (col->flags & TBL_CELL_WMAX))
397 col->width = (double)xwidth * ++necol / nxcol
399 if (necol == quirkcol)
401 ewidth += col->width;
407 tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
408 const struct tbl_opts *opts, const struct tbl_dat *dp, size_t mw)
412 /* Branch down into data sub-types. */
414 switch (dp->layout->pos) {
416 case TBL_CELL_DHORIZ:
417 sz = (*tbl->len)(1, tbl->arg);
418 if (col != NULL && col->width < sz)
422 case TBL_CELL_CENTRE:
425 return tblcalc_literal(tbl, col, dp, mw);
426 case TBL_CELL_NUMBER:
427 return tblcalc_number(tbl, col, opts, dp);
436 tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
437 const struct tbl_dat *dp, size_t mw)
439 const char *str; /* Beginning of the first line. */
440 const char *beg; /* Beginning of the current line. */
441 char *end; /* End of the current line. */
442 size_t lsz; /* Length of the current line. */
443 size_t wsz; /* Length of the current word. */
444 size_t msz; /* Length of the longest line. */
446 if (dp->string == NULL || *dp->string == '\0')
448 str = mw ? mandoc_strdup(dp->string) : dp->string;
450 for (beg = str; beg != NULL && *beg != '\0'; beg = end) {
451 end = mw ? strchr(beg, ' ') : NULL;
457 wsz = (*tbl->slen)(beg, tbl->arg);
458 if (mw && lsz && lsz + 1 + wsz <= mw)
467 if (col != NULL && col->width < msz)
473 tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
474 const struct tbl_opts *opts, const struct tbl_dat *dp)
476 const char *cp, *lastdigit, *lastpoint;
480 if (dp->string == NULL || *dp->string == '\0')
483 totsz = (*tbl->slen)(dp->string, tbl->arg);
488 * Find the last digit and
489 * the last decimal point that is adjacent to a digit.
490 * The alignment indicator "\&" overrides everything.
493 lastdigit = lastpoint = NULL;
494 for (cp = dp->string; cp[0] != '\0'; cp++) {
495 if (cp[0] == '\\' && cp[1] == '&') {
496 lastdigit = lastpoint = cp;
498 } else if (cp[0] == opts->decimal &&
499 (isdigit((unsigned char)cp[1]) ||
500 (cp > dp->string && isdigit((unsigned char)cp[-1]))))
502 else if (isdigit((unsigned char)cp[0]))
506 /* Not a number, treat as a literal string. */
508 if (lastdigit == NULL) {
509 if (col != NULL && col->width < totsz)
514 /* Measure the width of the integer part. */
516 if (lastpoint == NULL)
517 lastpoint = lastdigit + 1;
520 for (cp = dp->string; cp < lastpoint; cp++) {
522 intsz += (*tbl->slen)(buf, tbl->arg);
526 * If this number has more integer digits than all numbers
527 * seen on earlier lines, shift them all to the right.
528 * If it has fewer, shift this number to the right.
531 if (intsz > col->decimal) {
532 col->nwidth += intsz - col->decimal;
533 col->decimal = intsz;
535 totsz += col->decimal - intsz;
537 /* Update the maximum total width seen so far. */
539 if (totsz > col->nwidth)
541 if (col->nwidth > col->width)
542 col->width = col->nwidth;