Annotation of src/usr.bin/mandoc/out.c, Revision 1.56
1.56 ! schwarze 1: /* $OpenBSD: out.c,v 1.55 2021/09/28 17:06:17 schwarze Exp $ */
1.1 schwarze 2: /*
1.9 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.53 schwarze 4: * Copyright (c) 2011, 2014, 2015, 2017, 2018, 2019, 2021
5: * Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 6: *
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.
10: *
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.
18: */
19: #include <sys/types.h>
20:
1.2 schwarze 21: #include <assert.h>
1.45 schwarze 22: #include <ctype.h>
1.42 schwarze 23: #include <stdint.h>
1.52 schwarze 24: #include <stdio.h>
1.1 schwarze 25: #include <stdlib.h>
1.2 schwarze 26: #include <string.h>
27: #include <time.h>
1.1 schwarze 28:
1.20 schwarze 29: #include "mandoc_aux.h"
1.52 schwarze 30: #include "mandoc.h"
1.48 schwarze 31: #include "tbl.h"
1.1 schwarze 32: #include "out.h"
33:
1.47 schwarze 34: struct tbl_colgroup {
35: struct tbl_colgroup *next;
36: size_t wanted;
37: int startcol;
38: int endcol;
39: };
40:
41: static size_t tblcalc_data(struct rofftbl *, struct roffcol *,
1.37 schwarze 42: const struct tbl_opts *, const struct tbl_dat *,
43: size_t);
1.47 schwarze 44: static size_t tblcalc_literal(struct rofftbl *, struct roffcol *,
1.37 schwarze 45: const struct tbl_dat *, size_t);
1.47 schwarze 46: static size_t tblcalc_number(struct rofftbl *, struct roffcol *,
1.18 schwarze 47: const struct tbl_opts *, const struct tbl_dat *);
1.9 schwarze 48:
1.21 schwarze 49:
50: /*
1.27 schwarze 51: * Parse the *src string and store a scaling unit into *dst.
52: * If the string doesn't specify the unit, use the default.
53: * If no default is specified, fail.
1.36 schwarze 54: * Return a pointer to the byte after the last byte used,
55: * or NULL on total failure.
1.1 schwarze 56: */
1.36 schwarze 57: const char *
1.1 schwarze 58: a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
59: {
1.27 schwarze 60: char *endptr;
1.1 schwarze 61:
1.28 schwarze 62: dst->unit = def == SCALE_MAX ? SCALE_BU : def;
63: dst->scale = strtod(src, &endptr);
64: if (endptr == src)
1.36 schwarze 65: return NULL;
1.1 schwarze 66:
1.28 schwarze 67: switch (*endptr++) {
1.21 schwarze 68: case 'c':
1.28 schwarze 69: dst->unit = SCALE_CM;
1.1 schwarze 70: break;
1.21 schwarze 71: case 'i':
1.28 schwarze 72: dst->unit = SCALE_IN;
73: break;
74: case 'f':
75: dst->unit = SCALE_FS;
76: break;
77: case 'M':
78: dst->unit = SCALE_MM;
79: break;
80: case 'm':
81: dst->unit = SCALE_EM;
82: break;
83: case 'n':
84: dst->unit = SCALE_EN;
1.1 schwarze 85: break;
1.21 schwarze 86: case 'P':
1.28 schwarze 87: dst->unit = SCALE_PC;
1.1 schwarze 88: break;
1.21 schwarze 89: case 'p':
1.28 schwarze 90: dst->unit = SCALE_PT;
1.1 schwarze 91: break;
1.28 schwarze 92: case 'u':
93: dst->unit = SCALE_BU;
1.1 schwarze 94: break;
1.21 schwarze 95: case 'v':
1.28 schwarze 96: dst->unit = SCALE_VS;
1.1 schwarze 97: break;
1.40 schwarze 98: default:
1.28 schwarze 99: endptr--;
1.1 schwarze 100: if (SCALE_MAX == def)
1.36 schwarze 101: return NULL;
1.28 schwarze 102: dst->unit = def;
1.1 schwarze 103: break;
104: }
1.36 schwarze 105: return endptr;
1.3 schwarze 106: }
1.9 schwarze 107:
108: /*
109: * Calculate the abstract widths and decimal positions of columns in a
110: * table. This routine allocates the columns structures then runs over
111: * all rows and cells in the table. The function pointers in "tbl" are
112: * used for the actual width calculations.
113: */
114: void
1.47 schwarze 115: tblcalc(struct rofftbl *tbl, const struct tbl_span *sp_first,
1.38 schwarze 116: size_t offset, size_t rmargin)
1.9 schwarze 117: {
1.37 schwarze 118: struct roffsu su;
1.30 schwarze 119: const struct tbl_opts *opts;
1.47 schwarze 120: const struct tbl_span *sp;
1.9 schwarze 121: const struct tbl_dat *dp;
122: struct roffcol *col;
1.47 schwarze 123: struct tbl_colgroup *first_group, **gp, *g;
1.55 schwarze 124: size_t *colwidth;
1.47 schwarze 125: size_t ewidth, min1, min2, wanted, width, xwidth;
126: int done, icol, maxcol, necol, nxcol, quirkcol;
1.9 schwarze 127:
128: /*
129: * Allocate the master column specifiers. These will hold the
130: * widths and decimal positions for all cells in the column. It
131: * must be freed and nullified by the caller.
132: */
133:
1.47 schwarze 134: assert(tbl->cols == NULL);
135: tbl->cols = mandoc_calloc((size_t)sp_first->opts->cols,
1.21 schwarze 136: sizeof(struct roffcol));
1.47 schwarze 137: opts = sp_first->opts;
1.9 schwarze 138:
1.47 schwarze 139: maxcol = -1;
140: first_group = NULL;
141: for (sp = sp_first; sp != NULL; sp = sp->next) {
142: if (sp->pos != TBL_SPAN_DATA)
1.9 schwarze 143: continue;
1.47 schwarze 144:
1.9 schwarze 145: /*
146: * Account for the data cells in the layout, matching it
147: * to data cells in the data section.
148: */
1.47 schwarze 149:
150: for (dp = sp->first; dp != NULL; dp = dp->next) {
1.31 schwarze 151: icol = dp->layout->col;
1.50 schwarze 152: while (maxcol < icol + dp->hspans)
1.42 schwarze 153: tbl->cols[++maxcol].spacing = SIZE_MAX;
1.24 schwarze 154: col = tbl->cols + icol;
155: col->flags |= dp->layout->flags;
156: if (dp->layout->flags & TBL_CELL_WIGN)
157: continue;
1.47 schwarze 158:
159: /* Handle explicit width specifications. */
160:
1.37 schwarze 161: if (dp->layout->wstr != NULL &&
162: dp->layout->width == 0 &&
163: a2roffsu(dp->layout->wstr, &su, SCALE_EN)
164: != NULL)
165: dp->layout->width =
166: (*tbl->sulen)(&su, tbl->arg);
167: if (col->width < dp->layout->width)
168: col->width = dp->layout->width;
1.42 schwarze 169: if (dp->layout->spacing != SIZE_MAX &&
170: (col->spacing == SIZE_MAX ||
171: col->spacing < dp->layout->spacing))
172: col->spacing = dp->layout->spacing;
1.47 schwarze 173:
174: /*
175: * Calculate an automatic width.
176: * Except for spanning cells, apply it.
177: */
178:
179: width = tblcalc_data(tbl,
180: dp->hspans == 0 ? col : NULL,
181: opts, dp,
1.39 schwarze 182: dp->block == 0 ? 0 :
183: dp->layout->width ? dp->layout->width :
1.41 schwarze 184: rmargin ? (rmargin + sp->opts->cols / 2)
185: / (sp->opts->cols + 1) : 0);
1.47 schwarze 186: if (dp->hspans == 0)
187: continue;
188:
189: /*
1.56 ! schwarze 190: * Build a singly linked list
1.47 schwarze 191: * of all groups of columns joined by spans,
192: * recording the minimum width for each group.
193: */
194:
1.56 ! schwarze 195: gp = &first_group;
! 196: while (*gp != NULL && ((*gp)->startcol != icol ||
! 197: (*gp)->endcol != icol + dp->hspans))
1.47 schwarze 198: gp = &(*gp)->next;
1.56 ! schwarze 199: if (*gp == NULL) {
1.47 schwarze 200: g = mandoc_malloc(sizeof(*g));
201: g->next = *gp;
202: g->wanted = width;
203: g->startcol = icol;
204: g->endcol = icol + dp->hspans;
205: *gp = g;
206: } else if ((*gp)->wanted < width)
207: (*gp)->wanted = width;
1.24 schwarze 208: }
209: }
210:
211: /*
1.51 schwarze 212: * The minimum width of columns explicitly specified
213: * in the layout is 1n.
1.47 schwarze 214: */
215:
1.51 schwarze 216: if (maxcol < sp_first->opts->cols - 1)
217: maxcol = sp_first->opts->cols - 1;
218: for (icol = 0; icol <= maxcol; icol++) {
219: col = tbl->cols + icol;
220: if (col->width < 1)
221: col->width = 1;
222:
223: /*
224: * Column spacings are needed for span width
225: * calculations, so set the default values now.
226: */
227:
228: if (col->spacing == SIZE_MAX || icol == maxcol)
229: col->spacing = 3;
230: }
1.47 schwarze 231:
232: /*
233: * Replace the minimum widths with the missing widths,
234: * and dismiss groups that are already wide enough.
235: */
236:
237: gp = &first_group;
238: while ((g = *gp) != NULL) {
239: done = 0;
240: for (icol = g->startcol; icol <= g->endcol; icol++) {
241: width = tbl->cols[icol].width;
242: if (icol < g->endcol)
243: width += tbl->cols[icol].spacing;
244: if (g->wanted <= width) {
245: done = 1;
246: break;
247: } else
248: (*gp)->wanted -= width;
249: }
250: if (done) {
251: *gp = g->next;
252: free(g);
253: } else
254: gp = &(*gp)->next;
255: }
256:
1.55 schwarze 257: colwidth = mandoc_reallocarray(NULL, maxcol + 1, sizeof(*colwidth));
1.47 schwarze 258: while (first_group != NULL) {
259:
260: /*
1.55 schwarze 261: * Rebuild the array of the widths of all columns
262: * participating in spans that require expansion.
263: */
264:
265: for (icol = 0; icol <= maxcol; icol++)
266: colwidth[icol] = SIZE_MAX;
267: for (g = first_group; g != NULL; g = g->next)
268: for (icol = g->startcol; icol <= g->endcol; icol++)
269: colwidth[icol] = tbl->cols[icol].width;
270:
271: /*
1.47 schwarze 272: * Find the smallest and second smallest column width
273: * among the columns which may need expamsion.
274: */
275:
276: min1 = min2 = SIZE_MAX;
277: for (icol = 0; icol <= maxcol; icol++) {
1.55 schwarze 278: width = colwidth[icol];
1.54 schwarze 279: if (min1 > width) {
1.47 schwarze 280: min2 = min1;
1.54 schwarze 281: min1 = width;
282: } else if (min1 < width && min2 > width)
283: min2 = width;
1.47 schwarze 284: }
285:
286: /*
287: * Find the minimum wanted width
288: * for any one of the narrowest columns,
289: * and mark the columns wanting that width.
290: */
291:
292: wanted = min2;
293: for (g = first_group; g != NULL; g = g->next) {
294: necol = 0;
295: for (icol = g->startcol; icol <= g->endcol; icol++)
1.55 schwarze 296: if (colwidth[icol] == min1)
1.47 schwarze 297: necol++;
298: if (necol == 0)
299: continue;
300: width = min1 + (g->wanted - 1) / necol + 1;
301: if (width > min2)
302: width = min2;
303: if (wanted > width)
304: wanted = width;
305: }
306:
1.54 schwarze 307: /* Record the effect of the widening. */
1.47 schwarze 308:
309: gp = &first_group;
310: while ((g = *gp) != NULL) {
311: done = 0;
312: for (icol = g->startcol; icol <= g->endcol; icol++) {
1.55 schwarze 313: if (colwidth[icol] != min1)
1.47 schwarze 314: continue;
315: if (g->wanted <= wanted - min1) {
1.54 schwarze 316: tbl->cols[icol].width += g->wanted;
1.47 schwarze 317: done = 1;
318: break;
319: }
1.54 schwarze 320: tbl->cols[icol].width = wanted;
1.47 schwarze 321: g->wanted -= wanted - min1;
322: }
323: if (done) {
324: *gp = g->next;
325: free(g);
326: } else
327: gp = &(*gp)->next;
328: }
329: }
1.55 schwarze 330: free(colwidth);
1.47 schwarze 331:
332: /*
1.44 schwarze 333: * Align numbers with text.
1.24 schwarze 334: * Count columns to equalize and columns to maximize.
335: * Find maximum width of the columns to equalize.
336: * Find total width of the columns *not* to maximize.
337: */
338:
339: necol = nxcol = 0;
340: ewidth = xwidth = 0;
341: for (icol = 0; icol <= maxcol; icol++) {
342: col = tbl->cols + icol;
1.44 schwarze 343: if (col->width > col->nwidth)
344: col->decimal += (col->width - col->nwidth) / 2;
1.24 schwarze 345: if (col->flags & TBL_CELL_EQUAL) {
346: necol++;
347: if (ewidth < col->width)
348: ewidth = col->width;
349: }
350: if (col->flags & TBL_CELL_WMAX)
351: nxcol++;
352: else
353: xwidth += col->width;
354: }
355:
356: /*
357: * Equalize columns, if requested for any of them.
358: * Update total width of the columns not to maximize.
359: */
360:
361: if (necol) {
362: for (icol = 0; icol <= maxcol; icol++) {
363: col = tbl->cols + icol;
364: if ( ! (col->flags & TBL_CELL_EQUAL))
365: continue;
366: if (col->width == ewidth)
367: continue;
1.38 schwarze 368: if (nxcol && rmargin)
1.24 schwarze 369: xwidth += ewidth - col->width;
370: col->width = ewidth;
371: }
372: }
373:
374: /*
375: * If there are any columns to maximize, find the total
376: * available width, deducting 3n margins between columns.
377: * Distribute the available width evenly.
378: */
379:
1.38 schwarze 380: if (nxcol && rmargin) {
1.35 schwarze 381: xwidth += 3*maxcol +
1.30 schwarze 382: (opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ?
383: 2 : !!opts->lvert + !!opts->rvert);
1.38 schwarze 384: if (rmargin <= offset + xwidth)
1.35 schwarze 385: return;
1.38 schwarze 386: xwidth = rmargin - offset - xwidth;
1.30 schwarze 387:
388: /*
389: * Emulate a bug in GNU tbl width calculation that
390: * manifests itself for large numbers of x-columns.
391: * Emulating it for 5 x-columns gives identical
392: * behaviour for up to 6 x-columns.
393: */
394:
395: if (nxcol == 5) {
396: quirkcol = xwidth % nxcol + 2;
397: if (quirkcol != 3 && quirkcol != 4)
398: quirkcol = -1;
399: } else
400: quirkcol = -1;
401:
402: necol = 0;
403: ewidth = 0;
1.24 schwarze 404: for (icol = 0; icol <= maxcol; icol++) {
405: col = tbl->cols + icol;
406: if ( ! (col->flags & TBL_CELL_WMAX))
407: continue;
1.30 schwarze 408: col->width = (double)xwidth * ++necol / nxcol
409: - ewidth + 0.4995;
410: if (necol == quirkcol)
411: col->width--;
412: ewidth += col->width;
1.9 schwarze 413: }
414: }
415: }
416:
1.47 schwarze 417: static size_t
1.9 schwarze 418: tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
1.37 schwarze 419: const struct tbl_opts *opts, const struct tbl_dat *dp, size_t mw)
1.9 schwarze 420: {
421: size_t sz;
422:
423: /* Branch down into data sub-types. */
424:
425: switch (dp->layout->pos) {
1.21 schwarze 426: case TBL_CELL_HORIZ:
427: case TBL_CELL_DHORIZ:
1.9 schwarze 428: sz = (*tbl->len)(1, tbl->arg);
1.47 schwarze 429: if (col != NULL && col->width < sz)
1.9 schwarze 430: col->width = sz;
1.47 schwarze 431: return sz;
1.21 schwarze 432: case TBL_CELL_LONG:
433: case TBL_CELL_CENTRE:
434: case TBL_CELL_LEFT:
435: case TBL_CELL_RIGHT:
1.47 schwarze 436: return tblcalc_literal(tbl, col, dp, mw);
1.21 schwarze 437: case TBL_CELL_NUMBER:
1.47 schwarze 438: return tblcalc_number(tbl, col, opts, dp);
1.21 schwarze 439: case TBL_CELL_DOWN:
1.47 schwarze 440: return 0;
1.9 schwarze 441: default:
442: abort();
443: }
444: }
445:
1.47 schwarze 446: static size_t
1.9 schwarze 447: tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
1.37 schwarze 448: const struct tbl_dat *dp, size_t mw)
1.9 schwarze 449: {
1.37 schwarze 450: const char *str; /* Beginning of the first line. */
451: const char *beg; /* Beginning of the current line. */
452: char *end; /* End of the current line. */
1.38 schwarze 453: size_t lsz; /* Length of the current line. */
454: size_t wsz; /* Length of the current word. */
1.47 schwarze 455: size_t msz; /* Length of the longest line. */
1.37 schwarze 456:
457: if (dp->string == NULL || *dp->string == '\0')
1.47 schwarze 458: return 0;
1.37 schwarze 459: str = mw ? mandoc_strdup(dp->string) : dp->string;
1.47 schwarze 460: msz = lsz = 0;
1.37 schwarze 461: for (beg = str; beg != NULL && *beg != '\0'; beg = end) {
462: end = mw ? strchr(beg, ' ') : NULL;
463: if (end != NULL) {
464: *end++ = '\0';
465: while (*end == ' ')
466: end++;
467: }
1.38 schwarze 468: wsz = (*tbl->slen)(beg, tbl->arg);
469: if (mw && lsz && lsz + 1 + wsz <= mw)
470: lsz += 1 + wsz;
471: else
472: lsz = wsz;
1.47 schwarze 473: if (msz < lsz)
474: msz = lsz;
1.37 schwarze 475: }
476: if (mw)
477: free((void *)str);
1.47 schwarze 478: if (col != NULL && col->width < msz)
479: col->width = msz;
480: return msz;
1.9 schwarze 481: }
482:
1.47 schwarze 483: static size_t
1.9 schwarze 484: tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
1.18 schwarze 485: const struct tbl_opts *opts, const struct tbl_dat *dp)
1.9 schwarze 486: {
1.45 schwarze 487: const char *cp, *lastdigit, *lastpoint;
488: size_t intsz, totsz;
1.9 schwarze 489: char buf[2];
490:
1.45 schwarze 491: if (dp->string == NULL || *dp->string == '\0')
1.47 schwarze 492: return 0;
493:
494: totsz = (*tbl->slen)(dp->string, tbl->arg);
495: if (col == NULL)
496: return totsz;
1.45 schwarze 497:
1.9 schwarze 498: /*
1.45 schwarze 499: * Find the last digit and
500: * the last decimal point that is adjacent to a digit.
501: * The alignment indicator "\&" overrides everything.
1.9 schwarze 502: */
503:
1.45 schwarze 504: lastdigit = lastpoint = NULL;
505: for (cp = dp->string; cp[0] != '\0'; cp++) {
506: if (cp[0] == '\\' && cp[1] == '&') {
507: lastdigit = lastpoint = cp;
508: break;
509: } else if (cp[0] == opts->decimal &&
510: (isdigit((unsigned char)cp[1]) ||
511: (cp > dp->string && isdigit((unsigned char)cp[-1]))))
512: lastpoint = cp;
513: else if (isdigit((unsigned char)cp[0]))
514: lastdigit = cp;
515: }
516:
517: /* Not a number, treat as a literal string. */
518:
519: if (lastdigit == NULL) {
1.47 schwarze 520: if (col != NULL && col->width < totsz)
1.45 schwarze 521: col->width = totsz;
1.47 schwarze 522: return totsz;
1.45 schwarze 523: }
1.9 schwarze 524:
1.45 schwarze 525: /* Measure the width of the integer part. */
1.9 schwarze 526:
1.45 schwarze 527: if (lastpoint == NULL)
528: lastpoint = lastdigit + 1;
529: intsz = 0;
1.9 schwarze 530: buf[1] = '\0';
1.45 schwarze 531: for (cp = dp->string; cp < lastpoint; cp++) {
532: buf[0] = cp[0];
533: intsz += (*tbl->slen)(buf, tbl->arg);
534: }
535:
536: /*
537: * If this number has more integer digits than all numbers
538: * seen on earlier lines, shift them all to the right.
539: * If it has fewer, shift this number to the right.
540: */
1.9 schwarze 541:
1.45 schwarze 542: if (intsz > col->decimal) {
543: col->nwidth += intsz - col->decimal;
544: col->decimal = intsz;
1.9 schwarze 545: } else
1.45 schwarze 546: totsz += col->decimal - intsz;
1.9 schwarze 547:
1.45 schwarze 548: /* Update the maximum total width seen so far. */
1.9 schwarze 549:
1.45 schwarze 550: if (totsz > col->nwidth)
551: col->nwidth = totsz;
1.53 schwarze 552: if (col->nwidth > col->width)
553: col->width = col->nwidth;
1.47 schwarze 554: return totsz;
1.9 schwarze 555: }
![[BACK]](/icons/back.gif){kind=icon}
Return to out.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc