Annotation of src/usr.bin/mandoc/out.c, Revision 1.28
1.28 ! schwarze 1: /* $OpenBSD: out.c,v 1.27 2014/12/23 03:27:36 schwarze Exp $ */
1.1 schwarze 2: /*
1.9 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.24 schwarze 4: * Copyright (c) 2011, 2014 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.6 schwarze 95: /* FIXME: do this in the caller. */
1.28 ! schwarze 96: if (dst->scale < 0.0)
! 97: dst->scale = 0.0;
! 98: return(*endptr == '\0' ? 2 : 1);
1.3 schwarze 99: }
1.9 schwarze 100:
101: /*
102: * Calculate the abstract widths and decimal positions of columns in a
103: * table. This routine allocates the columns structures then runs over
104: * all rows and cells in the table. The function pointers in "tbl" are
105: * used for the actual width calculations.
106: */
107: void
1.24 schwarze 108: tblcalc(struct rofftbl *tbl, const struct tbl_span *sp,
109: size_t totalwidth)
1.9 schwarze 110: {
111: const struct tbl_dat *dp;
112: struct roffcol *col;
1.24 schwarze 113: size_t ewidth, xwidth;
1.16 schwarze 114: int spans;
1.24 schwarze 115: int icol, maxcol, necol, nxcol;
1.9 schwarze 116:
117: /*
118: * Allocate the master column specifiers. These will hold the
119: * widths and decimal positions for all cells in the column. It
120: * must be freed and nullified by the caller.
121: */
122:
123: assert(NULL == tbl->cols);
1.21 schwarze 124: tbl->cols = mandoc_calloc((size_t)sp->opts->cols,
125: sizeof(struct roffcol));
1.9 schwarze 126:
1.25 schwarze 127: for (maxcol = -1; sp; sp = sp->next) {
1.9 schwarze 128: if (TBL_SPAN_DATA != sp->pos)
129: continue;
1.16 schwarze 130: spans = 1;
1.9 schwarze 131: /*
132: * Account for the data cells in the layout, matching it
133: * to data cells in the data section.
134: */
135: for (dp = sp->first; dp; dp = dp->next) {
1.16 schwarze 136: /* Do not used spanned cells in the calculation. */
137: if (0 < --spans)
138: continue;
139: spans = dp->spans;
140: if (1 < spans)
141: continue;
1.24 schwarze 142: icol = dp->layout->head->ident;
143: if (maxcol < icol)
144: maxcol = icol;
145: col = tbl->cols + icol;
146: col->flags |= dp->layout->flags;
147: if (dp->layout->flags & TBL_CELL_WIGN)
148: continue;
1.18 schwarze 149: tblcalc_data(tbl, col, sp->opts, dp);
1.24 schwarze 150: }
151: }
152:
153: /*
154: * Count columns to equalize and columns to maximize.
155: * Find maximum width of the columns to equalize.
156: * Find total width of the columns *not* to maximize.
157: */
158:
159: necol = nxcol = 0;
160: ewidth = xwidth = 0;
161: for (icol = 0; icol <= maxcol; icol++) {
162: col = tbl->cols + icol;
163: if (col->flags & TBL_CELL_EQUAL) {
164: necol++;
165: if (ewidth < col->width)
166: ewidth = col->width;
167: }
168: if (col->flags & TBL_CELL_WMAX)
169: nxcol++;
170: else
171: xwidth += col->width;
172: }
173:
174: /*
175: * Equalize columns, if requested for any of them.
176: * Update total width of the columns not to maximize.
177: */
178:
179: if (necol) {
180: for (icol = 0; icol <= maxcol; icol++) {
181: col = tbl->cols + icol;
182: if ( ! (col->flags & TBL_CELL_EQUAL))
183: continue;
184: if (col->width == ewidth)
185: continue;
186: if (nxcol && totalwidth)
187: xwidth += ewidth - col->width;
188: col->width = ewidth;
189: }
190: }
191:
192: /*
193: * If there are any columns to maximize, find the total
194: * available width, deducting 3n margins between columns.
195: * Distribute the available width evenly.
196: */
197:
198: if (nxcol && totalwidth) {
199: xwidth = totalwidth - 3*maxcol - xwidth;
200: for (icol = 0; icol <= maxcol; icol++) {
201: col = tbl->cols + icol;
202: if ( ! (col->flags & TBL_CELL_WMAX))
203: continue;
204: col->width = xwidth / nxcol--;
205: xwidth -= col->width;
1.9 schwarze 206: }
207: }
208: }
209:
210: static void
211: tblcalc_data(struct rofftbl *tbl, struct roffcol *col,
1.18 schwarze 212: const struct tbl_opts *opts, const struct tbl_dat *dp)
1.9 schwarze 213: {
214: size_t sz;
215:
216: /* Branch down into data sub-types. */
217:
218: switch (dp->layout->pos) {
1.21 schwarze 219: case TBL_CELL_HORIZ:
1.9 schwarze 220: /* FALLTHROUGH */
1.21 schwarze 221: case TBL_CELL_DHORIZ:
1.9 schwarze 222: sz = (*tbl->len)(1, tbl->arg);
223: if (col->width < sz)
224: col->width = sz;
225: break;
1.21 schwarze 226: case TBL_CELL_LONG:
1.9 schwarze 227: /* FALLTHROUGH */
1.21 schwarze 228: case TBL_CELL_CENTRE:
1.9 schwarze 229: /* FALLTHROUGH */
1.21 schwarze 230: case TBL_CELL_LEFT:
1.9 schwarze 231: /* FALLTHROUGH */
1.21 schwarze 232: case TBL_CELL_RIGHT:
1.9 schwarze 233: tblcalc_literal(tbl, col, dp);
234: break;
1.21 schwarze 235: case TBL_CELL_NUMBER:
1.18 schwarze 236: tblcalc_number(tbl, col, opts, dp);
1.9 schwarze 237: break;
1.21 schwarze 238: case TBL_CELL_DOWN:
1.10 schwarze 239: break;
1.9 schwarze 240: default:
241: abort();
242: /* NOTREACHED */
243: }
244: }
245:
246: static void
247: tblcalc_literal(struct rofftbl *tbl, struct roffcol *col,
248: const struct tbl_dat *dp)
249: {
1.16 schwarze 250: size_t sz;
1.10 schwarze 251: const char *str;
1.9 schwarze 252:
1.10 schwarze 253: str = dp->string ? dp->string : "";
254: sz = (*tbl->slen)(str, tbl->arg);
255:
1.9 schwarze 256: if (col->width < sz)
257: col->width = sz;
258: }
259:
260: static void
261: tblcalc_number(struct rofftbl *tbl, struct roffcol *col,
1.18 schwarze 262: const struct tbl_opts *opts, const struct tbl_dat *dp)
1.9 schwarze 263: {
1.21 schwarze 264: int i;
1.10 schwarze 265: size_t sz, psz, ssz, d;
266: const char *str;
1.9 schwarze 267: char *cp;
268: char buf[2];
269:
270: /*
271: * First calculate number width and decimal place (last + 1 for
1.16 schwarze 272: * non-decimal numbers). If the stored decimal is subsequent to
1.9 schwarze 273: * ours, make our size longer by that difference
274: * (right-"shifting"); similarly, if ours is subsequent the
275: * stored, then extend the stored size by the difference.
276: * Finally, re-assign the stored values.
277: */
278:
1.10 schwarze 279: str = dp->string ? dp->string : "";
280: sz = (*tbl->slen)(str, tbl->arg);
1.9 schwarze 281:
1.10 schwarze 282: /* FIXME: TBL_DATA_HORIZ et al.? */
1.9 schwarze 283:
1.18 schwarze 284: buf[0] = opts->decimal;
1.9 schwarze 285: buf[1] = '\0';
286:
287: psz = (*tbl->slen)(buf, tbl->arg);
288:
1.18 schwarze 289: if (NULL != (cp = strrchr(str, opts->decimal))) {
1.9 schwarze 290: buf[1] = '\0';
291: for (ssz = 0, i = 0; cp != &str[i]; i++) {
292: buf[0] = str[i];
293: ssz += (*tbl->slen)(buf, tbl->arg);
294: }
295: d = ssz + psz;
296: } else
297: d = sz + psz;
298:
299: /* Adjust the settings for this column. */
300:
301: if (col->decimal > d) {
302: sz += col->decimal - d;
303: d = col->decimal;
304: } else
305: col->width += d - col->decimal;
306:
307: if (sz > col->width)
308: col->width = sz;
309: if (d > col->decimal)
310: col->decimal = d;
311: }