Annotation of mandoc/tbl_term.c, Revision 1.51
1.51 ! schwarze 1: /* $Id: tbl_term.c,v 1.50 2017/06/12 22:49:16 schwarze Exp $ */
1.1 kristaps 2: /*
1.20 kristaps 3: * Copyright (c) 2009, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.44 schwarze 4: * Copyright (c) 2011,2012,2014,2015,2017 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 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 "config.h"
1.28 schwarze 19:
20: #include <sys/types.h>
1.1 kristaps 21:
22: #include <assert.h>
23: #include <stdio.h>
24: #include <stdlib.h>
25: #include <string.h>
26:
27: #include "mandoc.h"
28: #include "out.h"
29: #include "term.h"
30:
1.11 kristaps 31: static size_t term_tbl_len(size_t, void *);
32: static size_t term_tbl_strlen(const char *, void *);
1.46 schwarze 33: static size_t term_tbl_sulen(const struct roffsu *, void *);
1.12 kristaps 34: static void tbl_char(struct termp *, char, size_t);
1.25 schwarze 35: static void tbl_data(struct termp *, const struct tbl_opts *,
1.27 schwarze 36: const struct tbl_dat *,
1.11 kristaps 37: const struct roffcol *);
1.27 schwarze 38: static void tbl_literal(struct termp *, const struct tbl_dat *,
1.11 kristaps 39: const struct roffcol *);
1.27 schwarze 40: static void tbl_number(struct termp *, const struct tbl_opts *,
41: const struct tbl_dat *,
1.11 kristaps 42: const struct roffcol *);
1.33 schwarze 43: static void tbl_hrule(struct termp *, const struct tbl_span *, int);
1.29 schwarze 44: static void tbl_word(struct termp *, const struct tbl_dat *);
1.11 kristaps 45:
46:
47: static size_t
1.46 schwarze 48: term_tbl_sulen(const struct roffsu *su, void *arg)
49: {
50: return term_hspan((const struct termp *)arg, su) / 24;
51: }
52:
53: static size_t
1.11 kristaps 54: term_tbl_strlen(const char *p, void *arg)
55: {
1.42 schwarze 56: return term_strlen((const struct termp *)arg, p);
1.11 kristaps 57: }
58:
59: static size_t
60: term_tbl_len(size_t sz, void *arg)
61: {
1.42 schwarze 62: return term_len((const struct termp *)arg, sz);
1.11 kristaps 63: }
1.1 kristaps 64:
65: void
66: term_tbl(struct termp *tp, const struct tbl_span *sp)
67: {
1.33 schwarze 68: const struct tbl_cell *cp;
1.11 kristaps 69: const struct tbl_dat *dp;
1.34 schwarze 70: static size_t offset;
1.47 schwarze 71: size_t coloff, tsz;
72: int ic, horiz, spans, vert, more;
73: char fc;
1.39 schwarze 74:
1.4 kristaps 75: /* Inhibit printing of spaces: we do padding ourselves. */
76:
1.47 schwarze 77: tp->flags |= TERMP_NOSPACE | TERMP_NONOSPACE;
1.4 kristaps 78:
79: /*
1.11 kristaps 80: * The first time we're invoked for a given table block,
81: * calculate the table widths and decimal positions.
1.4 kristaps 82: */
83:
1.37 schwarze 84: if (tp->tbl.cols == NULL) {
1.11 kristaps 85: tp->tbl.len = term_tbl_len;
86: tp->tbl.slen = term_tbl_strlen;
1.46 schwarze 87: tp->tbl.sulen = term_tbl_sulen;
1.11 kristaps 88: tp->tbl.arg = tp;
1.4 kristaps 89:
1.48 schwarze 90: tblcalc(&tp->tbl, sp, tp->tcol->offset, tp->tcol->rmargin);
1.1 kristaps 91:
1.34 schwarze 92: /* Center the table as a whole. */
93:
1.45 schwarze 94: offset = tp->tcol->offset;
1.34 schwarze 95: if (sp->opts->opts & TBL_OPT_CENTRE) {
96: tsz = sp->opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX)
97: ? 2 : !!sp->opts->lvert + !!sp->opts->rvert;
1.36 schwarze 98: for (ic = 0; ic < sp->opts->cols; ic++)
99: tsz += tp->tbl.cols[ic].width + 3;
1.34 schwarze 100: tsz -= 3;
1.45 schwarze 101: if (offset + tsz > tp->tcol->rmargin)
1.34 schwarze 102: tsz -= 1;
1.45 schwarze 103: tp->tcol->offset = offset + tp->tcol->rmargin > tsz ?
104: (offset + tp->tcol->rmargin - tsz) / 2 : 0;
1.34 schwarze 105: }
106:
1.33 schwarze 107: /* Horizontal frame at the start of boxed tables. */
1.4 kristaps 108:
1.33 schwarze 109: if (sp->opts->opts & TBL_OPT_DBOX)
110: tbl_hrule(tp, sp, 2);
111: if (sp->opts->opts & (TBL_OPT_DBOX | TBL_OPT_BOX))
112: tbl_hrule(tp, sp, 1);
1.21 schwarze 113: }
1.1 kristaps 114:
1.47 schwarze 115: /* Set up the columns. */
1.1 kristaps 116:
1.47 schwarze 117: tp->flags |= TERMP_MULTICOL;
118: horiz = 0;
119: switch (sp->pos) {
120: case TBL_SPAN_HORIZ:
121: case TBL_SPAN_DHORIZ:
122: horiz = 1;
123: term_setcol(tp, 1);
124: break;
125: case TBL_SPAN_DATA:
126: term_setcol(tp, sp->opts->cols + 2);
127: coloff = tp->tcol->offset;
128:
129: /* Set up a column for a left vertical frame. */
130:
131: if (sp->opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ||
132: sp->opts->lvert)
133: coloff++;
134: tp->tcol->rmargin = coloff;
1.33 schwarze 135:
1.47 schwarze 136: /* Set up the data columns. */
1.1 kristaps 137:
1.47 schwarze 138: dp = sp->first;
139: spans = 0;
140: for (ic = 0; ic < sp->opts->cols; ic++) {
141: if (spans == 0) {
142: tp->tcol++;
143: tp->tcol->offset = coloff;
144: }
145: coloff += tp->tbl.cols[ic].width;
146: tp->tcol->rmargin = coloff;
147: coloff++;
148: if (ic + 1 < sp->opts->cols)
149: coloff += 2;
150: if (spans) {
151: spans--;
152: continue;
153: }
154: if (dp == NULL)
155: continue;
156: spans = dp->spans;
157: dp = dp->next;
158: }
159:
160: /* Set up a column for a right vertical frame. */
161:
162: tp->tcol++;
163: tp->tcol->offset = coloff;
164: if (sp->opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX) ||
165: sp->opts->rvert)
166: coloff++;
167: tp->tcol->rmargin = coloff;
168:
169: /* Spans may have reduced the number of columns. */
170:
171: tp->lasttcol = tp->tcol - tp->tcols;
172:
173: /* Fill the buffers for all data columns. */
1.4 kristaps 174:
1.47 schwarze 175: tp->tcol = tp->tcols;
1.4 kristaps 176: dp = sp->first;
1.16 kristaps 177: spans = 0;
1.36 schwarze 178: for (ic = 0; ic < sp->opts->cols; ic++) {
1.47 schwarze 179: if (spans) {
180: spans--;
181: continue;
182: }
183: tp->tcol++;
184: tp->col = 0;
185: tbl_data(tp, sp->opts, dp, tp->tbl.cols + ic);
186: if (dp == NULL)
187: continue;
188: spans = dp->spans;
189: dp = dp->next;
190: }
191: break;
192: }
193:
194: do {
195: /* Print the vertical frame at the start of each row. */
196:
197: tp->tcol = tp->tcols;
198: fc = '\0';
199: if (sp->layout->vert ||
200: (sp->prev != NULL && sp->prev->layout->vert) ||
201: sp->opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX))
202: fc = horiz ? '+' : '|';
203: else if (horiz && sp->opts->lvert)
204: fc = '-';
205: if (fc != '\0') {
206: (*tp->advance)(tp, tp->tcols->offset);
207: (*tp->letter)(tp, fc);
208: tp->viscol = tp->tcol->offset + 1;
209: }
1.22 schwarze 210:
1.47 schwarze 211: /* Print the data cells. */
1.21 schwarze 212:
1.47 schwarze 213: more = 0;
214: if (horiz) {
215: tbl_hrule(tp, sp, 0);
216: term_flushln(tp);
217: } else {
218: cp = sp->layout->first;
219: dp = sp->first;
220: spans = 0;
221: for (ic = 0; ic < sp->opts->cols; ic++) {
222:
1.51 ! schwarze 223: /* Advance to next layout cell. */
1.47 schwarze 224:
225: if (cp != NULL) {
226: vert = cp->vert;
227: cp = cp->next;
228: } else
229: vert = 0;
1.51 ! schwarze 230:
! 231: /* Skip later cells in a span. */
! 232:
! 233: if (spans) {
! 234: spans--;
! 235: continue;
! 236: }
! 237:
! 238: /* Advance to next data cell. */
! 239:
! 240: if (dp != NULL) {
! 241: spans = dp->spans;
! 242: dp = dp->next;
! 243: }
! 244:
! 245: /* Print one line of text in the cell. */
! 246:
! 247: tp->tcol++;
! 248: if (tp->tcol->col < tp->tcol->lastcol)
! 249: term_flushln(tp);
! 250: if (tp->tcol->col < tp->tcol->lastcol)
! 251: more = 1;
! 252:
! 253: /*
! 254: * Vertical frames between data cells,
! 255: * but not after the last column.
! 256: */
! 257:
! 258: if (tp->tcol + 1 == tp->tcols + tp->lasttcol)
! 259: continue;
1.50 schwarze 260: if (vert == 0 &&
261: sp->opts->opts & TBL_OPT_ALLBOX)
1.49 schwarze 262: vert = 1;
1.47 schwarze 263: if (vert == 0)
264: continue;
265:
266: if (tp->tcol->rmargin + 1 > tp->viscol) {
267: (*tp->advance)(tp, tp->tcol->rmargin
268: + 1 - tp->viscol);
269: tp->viscol = tp->tcol->rmargin + 1;
270: }
271: while (vert--) {
272: (*tp->letter)(tp, '|');
273: tp->viscol++;
1.33 schwarze 274: }
1.47 schwarze 275: }
276: }
1.1 kristaps 277:
1.47 schwarze 278: /* Print the vertical frame at the end of each row. */
1.16 kristaps 279:
1.47 schwarze 280: fc = '\0';
281: if (sp->layout->last->vert ||
282: (sp->prev != NULL && sp->prev->layout->last->vert) ||
283: (sp->opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX)))
284: fc = horiz ? '+' : '|';
285: else if (horiz && sp->opts->rvert)
286: fc = '-';
287: if (fc != '\0') {
288: if (horiz == 0) {
289: tp->tcol++;
290: (*tp->advance)(tp,
291: tp->tcol->offset > tp->viscol ?
292: tp->tcol->offset - tp->viscol : 1);
293: }
294: (*tp->letter)(tp, fc);
295: }
296: (*tp->endline)(tp);
297: tp->viscol = 0;
298: } while (more);
1.1 kristaps 299:
1.4 kristaps 300: /*
301: * If we're the last row, clean up after ourselves: clear the
302: * existing table configuration and set it to NULL.
303: */
304:
1.47 schwarze 305: term_setcol(tp, 1);
306: tp->flags &= ~TERMP_MULTICOL;
307: tp->tcol->rmargin = tp->maxrmargin;
1.37 schwarze 308: if (sp->next == NULL) {
1.33 schwarze 309: if (sp->opts->opts & (TBL_OPT_DBOX | TBL_OPT_BOX)) {
310: tbl_hrule(tp, sp, 1);
1.24 schwarze 311: tp->skipvsp = 1;
312: }
1.33 schwarze 313: if (sp->opts->opts & TBL_OPT_DBOX) {
314: tbl_hrule(tp, sp, 2);
1.24 schwarze 315: tp->skipvsp = 2;
316: }
1.11 kristaps 317: assert(tp->tbl.cols);
318: free(tp->tbl.cols);
319: tp->tbl.cols = NULL;
1.45 schwarze 320: tp->tcol->offset = offset;
1.50 schwarze 321: } else if (horiz == 0 && sp->opts->opts & TBL_OPT_ALLBOX &&
322: (sp->next == NULL || sp->next->pos == TBL_SPAN_DATA ||
323: sp->next->next != NULL))
1.49 schwarze 324: tbl_hrule(tp, sp, 1);
325:
1.47 schwarze 326: tp->flags &= ~TERMP_NONOSPACE;
1.1 kristaps 327: }
328:
1.21 schwarze 329: /*
1.33 schwarze 330: * Kinds of horizontal rulers:
331: * 0: inside the table (single or double line with crossings)
332: * 1: inner frame (single line with crossings and ends)
333: * 2: outer frame (single line without crossings with ends)
1.21 schwarze 334: */
1.1 kristaps 335: static void
1.33 schwarze 336: tbl_hrule(struct termp *tp, const struct tbl_span *sp, int kind)
1.1 kristaps 337: {
1.33 schwarze 338: const struct tbl_cell *c1, *c2;
339: int vert;
340: char line, cross;
341:
342: line = (kind == 0 && TBL_SPAN_DHORIZ == sp->pos) ? '=' : '-';
343: cross = (kind < 2) ? '+' : '-';
344:
345: if (kind)
346: term_word(tp, "+");
347: c1 = sp->layout->first;
348: c2 = sp->prev == NULL ? NULL : sp->prev->layout->first;
349: if (c2 == c1)
350: c2 = NULL;
351: for (;;) {
1.36 schwarze 352: tbl_char(tp, line, tp->tbl.cols[c1->col].width + 1);
1.33 schwarze 353: vert = c1->vert;
354: if ((c1 = c1->next) == NULL)
355: break;
356: if (c2 != NULL) {
357: if (vert < c2->vert)
358: vert = c2->vert;
359: c2 = c2->next;
360: }
1.49 schwarze 361: if (sp->opts->opts & TBL_OPT_ALLBOX && !vert)
362: vert = 1;
1.33 schwarze 363: if (vert)
364: tbl_char(tp, cross, vert);
365: if (vert < 2)
366: tbl_char(tp, line, 2 - vert);
1.22 schwarze 367: }
1.33 schwarze 368: if (kind) {
369: term_word(tp, "+");
370: term_flushln(tp);
1.22 schwarze 371: }
1.1 kristaps 372: }
373:
374: static void
1.25 schwarze 375: tbl_data(struct termp *tp, const struct tbl_opts *opts,
1.27 schwarze 376: const struct tbl_dat *dp,
377: const struct roffcol *col)
1.1 kristaps 378: {
379:
1.35 schwarze 380: if (dp == NULL) {
1.11 kristaps 381: tbl_char(tp, ASCII_NBRSP, col->width);
1.1 kristaps 382: return;
383: }
384:
385: switch (dp->pos) {
1.27 schwarze 386: case TBL_DATA_NONE:
1.11 kristaps 387: tbl_char(tp, ASCII_NBRSP, col->width);
1.10 kristaps 388: return;
1.27 schwarze 389: case TBL_DATA_HORIZ:
390: case TBL_DATA_NHORIZ:
1.11 kristaps 391: tbl_char(tp, '-', col->width);
1.7 kristaps 392: return;
1.27 schwarze 393: case TBL_DATA_NDHORIZ:
394: case TBL_DATA_DHORIZ:
1.11 kristaps 395: tbl_char(tp, '=', col->width);
1.1 kristaps 396: return;
397: default:
398: break;
399: }
1.27 schwarze 400:
1.16 kristaps 401: switch (dp->layout->pos) {
1.27 schwarze 402: case TBL_CELL_HORIZ:
1.11 kristaps 403: tbl_char(tp, '-', col->width);
1.7 kristaps 404: break;
1.27 schwarze 405: case TBL_CELL_DHORIZ:
1.11 kristaps 406: tbl_char(tp, '=', col->width);
1.1 kristaps 407: break;
1.27 schwarze 408: case TBL_CELL_LONG:
409: case TBL_CELL_CENTRE:
410: case TBL_CELL_LEFT:
411: case TBL_CELL_RIGHT:
1.11 kristaps 412: tbl_literal(tp, dp, col);
1.1 kristaps 413: break;
1.27 schwarze 414: case TBL_CELL_NUMBER:
1.25 schwarze 415: tbl_number(tp, opts, dp, col);
1.18 kristaps 416: break;
1.27 schwarze 417: case TBL_CELL_DOWN:
1.18 kristaps 418: tbl_char(tp, ASCII_NBRSP, col->width);
1.1 kristaps 419: break;
420: default:
421: abort();
422: }
423: }
424:
425: static void
1.12 kristaps 426: tbl_char(struct termp *tp, char c, size_t len)
1.1 kristaps 427: {
1.12 kristaps 428: size_t i, sz;
429: char cp[2];
430:
431: cp[0] = c;
432: cp[1] = '\0';
1.1 kristaps 433:
1.3 kristaps 434: sz = term_strlen(tp, cp);
435:
436: for (i = 0; i < len; i += sz)
1.1 kristaps 437: term_word(tp, cp);
438: }
439:
440: static void
1.27 schwarze 441: tbl_literal(struct termp *tp, const struct tbl_dat *dp,
1.11 kristaps 442: const struct roffcol *col)
1.1 kristaps 443: {
1.36 schwarze 444: size_t len, padl, padr, width;
445: int ic, spans;
1.1 kristaps 446:
1.17 kristaps 447: assert(dp->string);
1.21 schwarze 448: len = term_strlen(tp, dp->string);
1.23 schwarze 449: width = col->width;
1.36 schwarze 450: ic = dp->layout->col;
451: spans = dp->spans;
452: while (spans--)
453: width += tp->tbl.cols[++ic].width + 3;
1.23 schwarze 454:
455: padr = width > len ? width - len : 0;
1.21 schwarze 456: padl = 0;
1.1 kristaps 457:
1.16 kristaps 458: switch (dp->layout->pos) {
1.27 schwarze 459: case TBL_CELL_LONG:
1.21 schwarze 460: padl = term_len(tp, 1);
461: padr = padr > padl ? padr - padl : 0;
1.1 kristaps 462: break;
1.27 schwarze 463: case TBL_CELL_CENTRE:
1.21 schwarze 464: if (2 > padr)
1.19 schwarze 465: break;
1.21 schwarze 466: padl = padr / 2;
1.19 schwarze 467: padr -= padl;
1.1 kristaps 468: break;
1.27 schwarze 469: case TBL_CELL_RIGHT:
1.21 schwarze 470: padl = padr;
471: padr = 0;
1.1 kristaps 472: break;
473: default:
474: break;
475: }
476:
477: tbl_char(tp, ASCII_NBRSP, padl);
1.29 schwarze 478: tbl_word(tp, dp);
1.21 schwarze 479: tbl_char(tp, ASCII_NBRSP, padr);
1.1 kristaps 480: }
481:
482: static void
1.25 schwarze 483: tbl_number(struct termp *tp, const struct tbl_opts *opts,
1.2 kristaps 484: const struct tbl_dat *dp,
1.11 kristaps 485: const struct roffcol *col)
1.1 kristaps 486: {
1.11 kristaps 487: char *cp;
488: char buf[2];
489: size_t sz, psz, ssz, d, padl;
490: int i;
1.1 kristaps 491:
492: /*
493: * See calc_data_number(). Left-pad by taking the offset of our
494: * and the maximum decimal; right-pad by the remaining amount.
495: */
496:
1.17 kristaps 497: assert(dp->string);
1.2 kristaps 498:
1.17 kristaps 499: sz = term_strlen(tp, dp->string);
1.2 kristaps 500:
1.25 schwarze 501: buf[0] = opts->decimal;
1.11 kristaps 502: buf[1] = '\0';
1.2 kristaps 503:
1.11 kristaps 504: psz = term_strlen(tp, buf);
1.10 kristaps 505:
1.35 schwarze 506: if ((cp = strrchr(dp->string, opts->decimal)) != NULL) {
1.17 kristaps 507: for (ssz = 0, i = 0; cp != &dp->string[i]; i++) {
508: buf[0] = dp->string[i];
1.5 kristaps 509: ssz += term_strlen(tp, buf);
510: }
511: d = ssz + psz;
512: } else
513: d = sz + psz;
1.2 kristaps 514:
1.32 schwarze 515: if (col->decimal > d && col->width > sz) {
516: padl = col->decimal - d;
517: if (padl + sz > col->width)
518: padl = col->width - sz;
519: tbl_char(tp, ASCII_NBRSP, padl);
520: } else
521: padl = 0;
1.29 schwarze 522: tbl_word(tp, dp);
1.21 schwarze 523: if (col->width > sz + padl)
524: tbl_char(tp, ASCII_NBRSP, col->width - sz - padl);
1.2 kristaps 525: }
526:
1.29 schwarze 527: static void
528: tbl_word(struct termp *tp, const struct tbl_dat *dp)
529: {
1.38 schwarze 530: int prev_font;
1.29 schwarze 531:
1.38 schwarze 532: prev_font = tp->fonti;
1.29 schwarze 533: if (dp->layout->flags & TBL_CELL_BOLD)
534: term_fontpush(tp, TERMFONT_BOLD);
535: else if (dp->layout->flags & TBL_CELL_ITALIC)
536: term_fontpush(tp, TERMFONT_UNDER);
537:
538: term_word(tp, dp->string);
539:
540: term_fontpopq(tp, prev_font);
541: }
CVSweb