Annotation of src/usr.bin/mandoc/tbl_layout.c, Revision 1.36
1.36 ! schwarze 1: /* $OpenBSD: tbl_layout.c,v 1.35 2018/12/14 05:17:45 schwarze Exp $ */
1.1 schwarze 2: /*
1.4 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.29 schwarze 4: * Copyright (c) 2012, 2014, 2015, 2017 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: */
1.16 schwarze 18: #include <sys/types.h>
19:
1.1 schwarze 20: #include <ctype.h>
1.31 schwarze 21: #include <stdint.h>
1.34 schwarze 22: #include <stdio.h>
1.1 schwarze 23: #include <stdlib.h>
24: #include <string.h>
1.4 schwarze 25: #include <time.h>
1.1 schwarze 26:
1.32 schwarze 27: #include "mandoc_aux.h"
1.4 schwarze 28: #include "mandoc.h"
1.32 schwarze 29: #include "tbl.h"
1.4 schwarze 30: #include "libmandoc.h"
1.33 schwarze 31: #include "tbl_int.h"
1.1 schwarze 32:
33: struct tbl_phrase {
34: char name;
35: enum tbl_cellt key;
36: };
37:
1.19 schwarze 38: static const struct tbl_phrase keys[] = {
1.1 schwarze 39: { 'c', TBL_CELL_CENTRE },
40: { 'r', TBL_CELL_RIGHT },
41: { 'l', TBL_CELL_LEFT },
42: { 'n', TBL_CELL_NUMBER },
43: { 's', TBL_CELL_SPAN },
44: { 'a', TBL_CELL_LONG },
45: { '^', TBL_CELL_DOWN },
46: { '-', TBL_CELL_HORIZ },
47: { '_', TBL_CELL_HORIZ },
1.11 schwarze 48: { '=', TBL_CELL_DHORIZ }
1.1 schwarze 49: };
50:
1.19 schwarze 51: #define KEYS_MAX ((int)(sizeof(keys)/sizeof(keys[0])))
52:
53: static void mods(struct tbl_node *, struct tbl_cell *,
1.4 schwarze 54: int, const char *, int *);
1.19 schwarze 55: static void cell(struct tbl_node *, struct tbl_row *,
1.1 schwarze 56: int, const char *, int *);
1.11 schwarze 57: static struct tbl_cell *cell_alloc(struct tbl_node *, struct tbl_row *,
1.20 schwarze 58: enum tbl_cellt);
1.1 schwarze 59:
1.14 schwarze 60:
1.19 schwarze 61: static void
1.14 schwarze 62: mods(struct tbl_node *tbl, struct tbl_cell *cp,
1.4 schwarze 63: int ln, const char *p, int *pos)
1.1 schwarze 64: {
1.19 schwarze 65: char *endptr;
1.36 ! schwarze 66: unsigned long spacing;
1.29 schwarze 67: size_t sz;
1.1 schwarze 68:
1.19 schwarze 69: mod:
70: while (p[*pos] == ' ' || p[*pos] == '\t')
71: (*pos)++;
1.9 schwarze 72:
1.19 schwarze 73: /* Row delimiters and cell specifiers end modifier lists. */
1.9 schwarze 74:
1.20 schwarze 75: if (strchr(".,-=^_ACLNRSaclnrs", p[*pos]) != NULL)
1.19 schwarze 76: return;
1.1 schwarze 77:
1.6 schwarze 78: /* Throw away parenthesised expression. */
79:
80: if ('(' == p[*pos]) {
81: (*pos)++;
82: while (p[*pos] && ')' != p[*pos])
83: (*pos)++;
84: if (')' == p[*pos]) {
85: (*pos)++;
86: goto mod;
87: }
1.35 schwarze 88: mandoc_msg(MANDOCERR_TBLLAYOUT_PAR, ln, *pos, NULL);
1.19 schwarze 89: return;
1.6 schwarze 90: }
91:
1.1 schwarze 92: /* Parse numerical spacing from modifier string. */
93:
1.4 schwarze 94: if (isdigit((unsigned char)p[*pos])) {
1.36 ! schwarze 95: if ((spacing = strtoul(p + *pos, &endptr, 10)) > 9)
! 96: mandoc_msg(MANDOCERR_TBLLAYOUT_SPC, ln, *pos,
! 97: "%lu", spacing);
! 98: else
! 99: cp->spacing = spacing;
1.19 schwarze 100: *pos = endptr - p;
1.4 schwarze 101: goto mod;
1.14 schwarze 102: }
1.1 schwarze 103:
1.6 schwarze 104: switch (tolower((unsigned char)p[(*pos)++])) {
1.19 schwarze 105: case 'b':
1.25 schwarze 106: cp->flags |= TBL_CELL_BOLD;
107: goto mod;
1.19 schwarze 108: case 'd':
109: cp->flags |= TBL_CELL_BALIGN;
1.4 schwarze 110: goto mod;
1.14 schwarze 111: case 'e':
1.1 schwarze 112: cp->flags |= TBL_CELL_EQUAL;
1.4 schwarze 113: goto mod;
1.19 schwarze 114: case 'f':
115: break;
1.25 schwarze 116: case 'i':
117: cp->flags |= TBL_CELL_ITALIC;
118: goto mod;
1.19 schwarze 119: case 'm':
1.35 schwarze 120: mandoc_msg(MANDOCERR_TBLLAYOUT_MOD, ln, *pos, "m");
1.19 schwarze 121: goto mod;
122: case 'p':
123: case 'v':
124: if (p[*pos] == '-' || p[*pos] == '+')
125: (*pos)++;
126: while (isdigit((unsigned char)p[*pos]))
127: (*pos)++;
128: goto mod;
1.14 schwarze 129: case 't':
1.1 schwarze 130: cp->flags |= TBL_CELL_TALIGN;
1.4 schwarze 131: goto mod;
1.19 schwarze 132: case 'u':
133: cp->flags |= TBL_CELL_UP;
1.5 schwarze 134: goto mod;
1.29 schwarze 135: case 'w':
136: sz = 0;
137: if (p[*pos] == '(') {
138: (*pos)++;
139: while (p[*pos + sz] != '\0' && p[*pos + sz] != ')')
140: sz++;
141: } else
142: while (isdigit((unsigned char)p[*pos + sz]))
143: sz++;
144: if (sz) {
145: free(cp->wstr);
146: cp->wstr = mandoc_strndup(p + *pos, sz);
147: *pos += sz;
148: if (p[*pos] == ')')
149: (*pos)++;
150: }
1.16 schwarze 151: goto mod;
152: case 'x':
153: cp->flags |= TBL_CELL_WMAX;
1.4 schwarze 154: goto mod;
1.19 schwarze 155: case 'z':
156: cp->flags |= TBL_CELL_WIGN;
157: goto mod;
1.20 schwarze 158: case '|':
159: if (cp->vert < 2)
160: cp->vert++;
161: else
162: mandoc_msg(MANDOCERR_TBLLAYOUT_VERT,
1.35 schwarze 163: ln, *pos - 1, NULL);
1.20 schwarze 164: goto mod;
1.1 schwarze 165: default:
1.35 schwarze 166: mandoc_msg(MANDOCERR_TBLLAYOUT_CHAR,
1.19 schwarze 167: ln, *pos - 1, "%c", p[*pos - 1]);
168: goto mod;
1.1 schwarze 169: }
170:
1.25 schwarze 171: /* Ignore parenthised font names for now. */
172:
173: if (p[*pos] == '(')
174: goto mod;
175:
176: /* Support only one-character font-names for now. */
177:
178: if (p[*pos] == '\0' || (p[*pos + 1] != ' ' && p[*pos + 1] != '.')) {
1.35 schwarze 179: mandoc_msg(MANDOCERR_FT_BAD,
1.25 schwarze 180: ln, *pos, "TS %s", p + *pos - 1);
181: if (p[*pos] != '\0')
182: (*pos)++;
183: if (p[*pos] != '\0')
184: (*pos)++;
185: goto mod;
186: }
187:
188: switch (p[(*pos)++]) {
1.14 schwarze 189: case '3':
1.25 schwarze 190: case 'B':
1.1 schwarze 191: cp->flags |= TBL_CELL_BOLD;
1.4 schwarze 192: goto mod;
1.14 schwarze 193: case '2':
1.25 schwarze 194: case 'I':
1.1 schwarze 195: cp->flags |= TBL_CELL_ITALIC;
1.10 schwarze 196: goto mod;
1.14 schwarze 197: case '1':
1.25 schwarze 198: case 'R':
1.4 schwarze 199: goto mod;
1.1 schwarze 200: default:
1.35 schwarze 201: mandoc_msg(MANDOCERR_FT_BAD,
1.15 schwarze 202: ln, *pos - 1, "TS f%c", p[*pos - 1]);
203: goto mod;
1.1 schwarze 204: }
205: }
206:
1.19 schwarze 207: static void
1.14 schwarze 208: cell(struct tbl_node *tbl, struct tbl_row *rp,
1.4 schwarze 209: int ln, const char *p, int *pos)
1.1 schwarze 210: {
1.20 schwarze 211: int i;
1.1 schwarze 212: enum tbl_cellt c;
213:
1.20 schwarze 214: /* Handle leading vertical lines */
1.11 schwarze 215:
1.19 schwarze 216: while (p[*pos] == ' ' || p[*pos] == '\t' || p[*pos] == '|') {
217: if (p[*pos] == '|') {
1.20 schwarze 218: if (rp->vert < 2)
219: rp->vert++;
1.19 schwarze 220: else
221: mandoc_msg(MANDOCERR_TBLLAYOUT_VERT,
1.35 schwarze 222: ln, *pos, NULL);
1.19 schwarze 223: }
1.11 schwarze 224: (*pos)++;
1.19 schwarze 225: }
1.13 schwarze 226:
1.20 schwarze 227: again:
228: while (p[*pos] == ' ' || p[*pos] == '\t')
229: (*pos)++;
1.13 schwarze 230:
1.20 schwarze 231: if (p[*pos] == '.' || p[*pos] == '\0')
1.19 schwarze 232: return;
1.11 schwarze 233:
234: /* Parse the column position (`c', `l', `r', ...). */
1.1 schwarze 235:
1.4 schwarze 236: for (i = 0; i < KEYS_MAX; i++)
1.6 schwarze 237: if (tolower((unsigned char)p[*pos]) == keys[i].name)
1.4 schwarze 238: break;
239:
1.19 schwarze 240: if (i == KEYS_MAX) {
1.35 schwarze 241: mandoc_msg(MANDOCERR_TBLLAYOUT_CHAR,
1.19 schwarze 242: ln, *pos, "%c", p[*pos]);
243: (*pos)++;
244: goto again;
1.1 schwarze 245: }
1.6 schwarze 246: c = keys[i].key;
247:
1.19 schwarze 248: /* Special cases of spanners. */
1.7 schwarze 249:
1.19 schwarze 250: if (c == TBL_CELL_SPAN) {
251: if (rp->last == NULL)
1.35 schwarze 252: mandoc_msg(MANDOCERR_TBLLAYOUT_SPAN, ln, *pos, NULL);
1.19 schwarze 253: else if (rp->last->pos == TBL_CELL_HORIZ ||
254: rp->last->pos == TBL_CELL_DHORIZ)
255: c = rp->last->pos;
256: } else if (c == TBL_CELL_DOWN && rp == tbl->first_row)
1.35 schwarze 257: mandoc_msg(MANDOCERR_TBLLAYOUT_DOWN, ln, *pos, NULL);
1.6 schwarze 258:
1.4 schwarze 259: (*pos)++;
1.1 schwarze 260:
261: /* Allocate cell then parse its modifiers. */
262:
1.20 schwarze 263: mods(tbl, cell_alloc(tbl, rp, c), ln, p, pos);
1.1 schwarze 264: }
265:
1.18 schwarze 266: void
1.21 schwarze 267: tbl_layout(struct tbl_node *tbl, int ln, const char *p, int pos)
1.1 schwarze 268: {
269: struct tbl_row *rp;
270:
1.17 schwarze 271: rp = NULL;
272: for (;;) {
273: /* Skip whitespace before and after each cell. */
1.4 schwarze 274:
1.19 schwarze 275: while (p[pos] == ' ' || p[pos] == '\t')
1.17 schwarze 276: pos++;
1.4 schwarze 277:
1.17 schwarze 278: switch (p[pos]) {
279: case ',': /* Next row on this input line. */
280: pos++;
281: rp = NULL;
282: continue;
283: case '\0': /* Next row on next input line. */
1.18 schwarze 284: return;
1.17 schwarze 285: case '.': /* End of layout. */
286: pos++;
287: tbl->part = TBL_PART_DATA;
1.20 schwarze 288:
289: /*
290: * When the layout is completely empty,
291: * default to one left-justified column.
292: */
293:
294: if (tbl->first_row == NULL) {
1.22 schwarze 295: tbl->first_row = tbl->last_row =
296: mandoc_calloc(1, sizeof(*rp));
297: }
298: if (tbl->first_row->first == NULL) {
1.20 schwarze 299: mandoc_msg(MANDOCERR_TBLLAYOUT_NONE,
1.35 schwarze 300: ln, pos, NULL);
1.22 schwarze 301: cell_alloc(tbl, tbl->first_row,
302: TBL_CELL_LEFT);
1.30 schwarze 303: if (tbl->opts.lvert < tbl->first_row->vert)
304: tbl->opts.lvert = tbl->first_row->vert;
1.18 schwarze 305: return;
1.20 schwarze 306: }
307:
308: /*
309: * Search for the widest line
310: * along the left and right margins.
311: */
312:
313: for (rp = tbl->first_row; rp; rp = rp->next) {
314: if (tbl->opts.lvert < rp->vert)
315: tbl->opts.lvert = rp->vert;
316: if (rp->last != NULL &&
1.24 schwarze 317: rp->last->col + 1 == tbl->opts.cols &&
1.20 schwarze 318: tbl->opts.rvert < rp->last->vert)
319: tbl->opts.rvert = rp->last->vert;
1.22 schwarze 320:
321: /* If the last line is empty, drop it. */
322:
323: if (rp->next != NULL &&
324: rp->next->first == NULL) {
325: free(rp->next);
326: rp->next = NULL;
1.26 schwarze 327: tbl->last_row = rp;
1.22 schwarze 328: }
1.20 schwarze 329: }
1.18 schwarze 330: return;
1.17 schwarze 331: default: /* Cell. */
332: break;
333: }
334:
1.22 schwarze 335: /*
336: * If the last line had at least one cell,
337: * start a new one; otherwise, continue it.
338: */
339:
340: if (rp == NULL) {
341: if (tbl->last_row == NULL ||
342: tbl->last_row->first != NULL) {
343: rp = mandoc_calloc(1, sizeof(*rp));
344: if (tbl->last_row)
345: tbl->last_row->next = rp;
346: else
347: tbl->first_row = rp;
348: tbl->last_row = rp;
349: } else
350: rp = tbl->last_row;
1.17 schwarze 351: }
1.19 schwarze 352: cell(tbl, rp, ln, p, &pos);
1.1 schwarze 353: }
354: }
1.4 schwarze 355:
356: static struct tbl_cell *
1.20 schwarze 357: cell_alloc(struct tbl_node *tbl, struct tbl_row *rp, enum tbl_cellt pos)
1.4 schwarze 358: {
359: struct tbl_cell *p, *pp;
360:
1.23 schwarze 361: p = mandoc_calloc(1, sizeof(*p));
1.31 schwarze 362: p->spacing = SIZE_MAX;
1.24 schwarze 363: p->pos = pos;
1.4 schwarze 364:
1.23 schwarze 365: if ((pp = rp->last) != NULL) {
1.11 schwarze 366: pp->next = p;
1.24 schwarze 367: p->col = pp->col + 1;
368: } else
1.11 schwarze 369: rp->first = p;
370: rp->last = p;
1.4 schwarze 371:
1.24 schwarze 372: if (tbl->opts.cols <= p->col)
373: tbl->opts.cols = p->col + 1;
1.4 schwarze 374:
1.27 schwarze 375: return p;
1.4 schwarze 376: }