Annotation of src/usr.bin/mandoc/out.c, Revision 1.30
1.30 ! schwarze 1: /* $OpenBSD: out.c,v 1.29 2014/12/23 13:48:15 schwarze Exp $ */
1.1 schwarze 2: /*
1.9 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.30 ! schwarze 4: * Copyright (c) 2011, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18: #include <sys/types.h>
19:
1.2 schwarze 20: #include <assert.h>
1.1 schwarze 21: #include <stdlib.h>
1.2 schwarze 22: #include <string.h>
23: #include <time.h>
1.1 schwarze 24:
1.20 schwarze 25: #include "mandoc_aux.h"
1.9 schwarze 26: #include "mandoc.h"
1.1 schwarze 27: #include "out.h"
28:
1.9 schwarze 29: static void tblcalc_data(struct rofftbl *, struct roffcol *,
1.18 schwarze 30: const struct tbl_opts *, const struct tbl_dat *);
1.9 schwarze 31: static void tblcalc_literal(struct rofftbl *, struct roffcol *,
32: const struct tbl_dat *);
33: static void tblcalc_number(struct rofftbl *, struct roffcol *,
1.18 schwarze 34: const struct tbl_opts *, const struct tbl_dat *);
1.9 schwarze 35:
1.21 schwarze 36:
37: /*
1.27 schwarze 38: * Parse the *src string and store a scaling unit into *dst.
39: * If the string doesn't specify the unit, use the default.
40: * If no default is specified, fail.
1.28 schwarze 41: * Return 2 on complete success, 1 when a conversion was done,
42: * but there was trailing garbage, and 0 on total failure.
1.1 schwarze 43: */
44: int
45: a2roffsu(const char *src, struct roffsu *dst, enum roffscale def)
46: {
1.27 schwarze 47: char *endptr;
1.1 schwarze 48:
1.28 schwarze 49: dst->unit = def == SCALE_MAX ? SCALE_BU : def;
50: dst->scale = strtod(src, &endptr);
51: if (endptr == src)
1.1 schwarze 52: return(0);
53:
1.28 schwarze 54: switch (*endptr++) {
1.21 schwarze 55: case 'c':
1.28 schwarze 56: dst->unit = SCALE_CM;
1.1 schwarze 57: break;
1.21 schwarze 58: case 'i':
1.28 schwarze 59: dst->unit = SCALE_IN;
60: break;
61: case 'f':
62: dst->unit = SCALE_FS;
63: break;
64: case 'M':
65: dst->unit = SCALE_MM;
66: break;
67: case 'm':
68: dst->unit = SCALE_EM;
69: break;
70: case 'n':
71: dst->unit = SCALE_EN;
1.1 schwarze 72: break;
1.21 schwarze 73: case 'P':
1.28 schwarze 74: dst->unit = SCALE_PC;
1.1 schwarze 75: break;
1.21 schwarze 76: case 'p':
1.28 schwarze 77: dst->unit = SCALE_PT;
1.1 schwarze 78: break;
1.28 schwarze 79: case 'u':
80: dst->unit = SCALE_BU;
1.1 schwarze 81: break;
1.21 schwarze 82: case 'v':
1.28 schwarze 83: dst->unit = SCALE_VS;
1.1 schwarze 84: break;
1.21 schwarze 85: case '\0':
1.28 schwarze 86: endptr--;
87: /* FALLTHROUGH */
88: default:
1.1 schwarze 89: if (SCALE_MAX == def)
90: return(0);
1.28 schwarze 91: dst->unit = def;
1.1 schwarze 92: break;
93: }
94:
1.28 schwarze 95: return(*endptr == '\0' ? 2 : 1);
1.3 schwarze 96: }
1.9 schwarze 97:
98: /*
99: * Calculate the abstract widths and decimal positions of columns in a
100: * table. This routine allocates the columns structures then runs over
101: * all rows and cells in the table. The function pointers in "tbl" are
102: * used for the actual width calculations.
103: */
104: void
1.24 schwarze 105: tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
106: size_t totalwidth)
1.9 schwarze 107: {
1.30 ! schwarze 108: const struct tbl_opts *opts;
1.9 schwarze 109: const struct tbl_dat *dp;
110: struct roffcol *col;
1.24 schwarze 111: size_t ewidth, xwidth;
1.16 schwarze 112: int spans;
1.30 ! schwarze 113: int icol, maxcol, necol, nxcol, quirkcol;
1.9 schwarze 114:
115: /*
116: * Allocate the master column specifiers. These will hold the
117: * widths and decimal positions for all cells in the column. It
118: * must be freed and nullified by the caller.
119: */
120:
121: assert(NULL == tbl->cols);
1.21 schwarze 122: tbl->cols = mandoc_calloc((size_t)sp->opts->cols,
123: sizeof(struct roffcol));
1.30 ! schwarze 124: opts = sp->opts;
1.9 schwarze 125:
1.25 schwarze 126: for (maxcol = -1; sp; sp = sp->next) {
1.9 schwarze 127: if (TBL_SPAN_DATA != sp->pos)
128: continue;
1.16 schwarze 129: spans = 1;
1.9 schwarze 130: /*
131: * Account for the data cells in the layout, matching it
132: * to data cells in the data section.
133: */
134: for (dp = sp->first; dp; dp = dp->next) {
1.16 schwarze 135: /* Do not used spanned cells in the calculation. */
136: if (0 < --spans)
137: continue;
138: spans = dp->spans;
139: if (1 < spans)
140: continue;
1.24 schwarze 141: icol = dp->layout->head->ident;
142: if (maxcol < icol)
143: maxcol = icol;
144: col = tbl->cols + icol;
145: col->flags |= dp->layout->flags;
146: if (dp->layout->flags & TBL_CELL_WIGN)
147: continue;
1.30 ! schwarze 148: tblcalc_data(tbl, col, opts, dp);
1.24 schwarze 149: }
150: }
151:
152: /*
153: * Count columns to equalize and columns to maximize.
154: * Find maximum width of the columns to equalize.
155: * Find total width of the columns *not* to maximize.
156: */
157:
158: necol = nxcol = 0;
159: ewidth = xwidth = 0;
160: for (icol = 0; icol <= maxcol; icol++) {
161: col = tbl->cols + icol;
162: if (col->flags & TBL_CELL_EQUAL) {
163: necol++;
164: if (ewidth < col->width)
165: ewidth = col->width;
166: }
167: if (col->flags & TBL_CELL_WMAX)
168: nxcol++;
169: else
170: xwidth += col->width;
171: }
172:
173: /*
174: * Equalize columns, if requested for any of them.
175: * Update total width of the columns not to maximize.
176: */
177:
178: if (necol) {
179: for (icol = 0; icol <= maxcol; icol++) {
180: col = tbl->cols + icol;
181: if ( ! (col->flags & TBL_CELL_EQUAL))
182: continue;
183: if (col->width == ewidth)
184: continue;
185: if (nxcol && totalwidth)
186: xwidth += ewidth - col->width;
187: col->width = ewidth;
188: }
189: }
190:
191: /*
192: * If there are any columns to maximize, find the total
193: * available width, deducting 3n margins between columns.
194: * Distribute the available width evenly.
195: */
196:
197: if (nxcol && totalwidth) {
1.30 ! schwarze 198: xwidth = totalwidth - xwidth - 3*maxcol -
! 199: (opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ?
! 200: 2 : !!opts->lvert + !!opts->rvert);
! 201:
! 202: /*
! 203: * Emulate a bug in GNU tbl width calculation that
! 204: * manifests itself for large numbers of x-columns.
! 205: * Emulating it for 5 x-columns gives identical
! 206: * behaviour for up to 6 x-columns.
! 207: */
! 208:
! 209: if (nxcol == 5) {
! 210: quirkcol = xwidth % nxcol + 2;
! 211: if (quirkcol != 3 && quirkcol != 4)
! 212: quirkcol = -1;
! 213: } else
! 214: quirkcol = -1;
! 215:
! 216: necol = 0;
! 217: ewidth = 0;
1.24 schwarze 218: for (icol = 0; icol <= maxcol; icol++) {
219: col = tbl->cols + icol;
220: if ( ! (col->flags & TBL_CELL_WMAX))
221: continue;
1.30 ! schwarze 222: col->width = (double)xwidth * ++necol / nxcol
! 223: - ewidth + 0.4995;
! 224: if (necol == quirkcol)
! 225: col->width--;
! 226: ewidth += col->width;
1.9 schwarze 227: }
228: }
229: }
230:
231: static void
232: tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
1.18 schwarze 233: const struct tbl_opts *opts, const struct tbl_dat *dp)
1.9 schwarze 234: {
235: size_t sz;
236:
237: /* Branch down into data sub-types. */
238:
239: switch (dp->layout->pos) {
1.21 schwarze 240: case TBL_CELL_HORIZ:
1.9 schwarze 241: /* FALLTHROUGH */
1.21 schwarze 242: case TBL_CELL_DHORIZ:
1.9 schwarze 243: sz = (*tbl->len)(1, tbl->arg);
244: if (col->width < sz)
245: col->width = sz;
246: break;
1.21 schwarze 247: case TBL_CELL_LONG:
1.9 schwarze 248: /* FALLTHROUGH */
1.21 schwarze 249: case TBL_CELL_CENTRE:
1.9 schwarze 250: /* FALLTHROUGH */
1.21 schwarze 251: case TBL_CELL_LEFT:
1.9 schwarze 252: /* FALLTHROUGH */
1.21 schwarze 253: case TBL_CELL_RIGHT:
1.9 schwarze 254: tblcalc_literal(tbl, col, dp);
255: break;
1.21 schwarze 256: case TBL_CELL_NUMBER:
1.18 schwarze 257: tblcalc_number(tbl, col, opts, dp);
1.9 schwarze 258: break;
1.21 schwarze 259: case TBL_CELL_DOWN:
1.10 schwarze 260: break;
1.9 schwarze 261: default:
262: abort();
263: /* NOTREACHED */
264: }
265: }
266:
267: static void
268: tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
269: const struct tbl_dat *dp)
270: {
1.16 schwarze 271: size_t sz;
1.10 schwarze 272: const char *str;
1.9 schwarze 273:
1.10 schwarze 274: str = dp->string ? dp->string : "";
275: sz = (*tbl->slen)(str, tbl->arg);
276:
1.9 schwarze 277: if (col->width < sz)
278: col->width = sz;
279: }
280:
281: static void
282: tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
1.18 schwarze 283: const struct tbl_opts *opts, const struct tbl_dat *dp)
1.9 schwarze 284: {
1.21 schwarze 285: int i;
1.10 schwarze 286: size_t sz, psz, ssz, d;
287: const char *str;
1.9 schwarze 288: char *cp;
289: char buf[2];
290:
291: /*
292: * First calculate number width and decimal place (last + 1 for
1.16 schwarze 293: * non-decimal numbers). If the stored decimal is subsequent to
1.9 schwarze 294: * ours, make our size longer by that difference
295: * (right-"shifting"); similarly, if ours is subsequent the
296: * stored, then extend the stored size by the difference.
297: * Finally, re-assign the stored values.
298: */
299:
1.10 schwarze 300: str = dp->string ? dp->string : "";
301: sz = (*tbl->slen)(str, tbl->arg);
1.9 schwarze 302:
1.10 schwarze 303: /* FIXME: TBL_DATA_HORIZ et al.? */
1.9 schwarze 304:
1.18 schwarze 305: buf[0] = opts->decimal;
1.9 schwarze 306: buf[1] = '\0';
307:
308: psz = (*tbl->slen)(buf, tbl->arg);
309:
1.18 schwarze 310: if (NULL != (cp = strrchr(str, opts->decimal))) {
1.9 schwarze 311: buf[1] = '\0';
312: for (ssz = 0, i = 0; cp != &str[i]; i++) {
313: buf[0] = str[i];
314: ssz += (*tbl->slen)(buf, tbl->arg);
315: }
316: d = ssz + psz;
317: } else
318: d = sz + psz;
319:
320: /* Adjust the settings for this column. */
321:
322: if (col->decimal > d) {
323: sz += col->decimal - d;
324: d = col->decimal;
325: } else
326: col->width += d - col->decimal;
327:
328: if (sz > col->width)
329: col->width = sz;
330: if (d > col->decimal)
331: col->decimal = d;
332: }