Annotation of mandoc/tbl_layout.c, Revision 1.29
1.29 ! schwarze 1: /* $Id: tbl_layout.c,v 1.28 2014/10/07 14:07:03 schwarze Exp $ */
1.1 kristaps 2: /*
1.22 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.25 schwarze 4: * Copyright (c) 2012, 2014 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: */
1.18 kristaps 18: #include "config.h"
1.27 schwarze 19:
20: #include <sys/types.h>
1.18 kristaps 21:
1.1 kristaps 22: #include <ctype.h>
23: #include <stdlib.h>
24: #include <string.h>
1.4 kristaps 25: #include <time.h>
1.1 kristaps 26:
27: #include "mandoc.h"
1.24 schwarze 28: #include "mandoc_aux.h"
1.1 kristaps 29: #include "libmandoc.h"
30: #include "libroff.h"
31:
32: struct tbl_phrase {
33: char name;
34: enum tbl_cellt key;
35: };
36:
1.11 kristaps 37: /*
38: * FIXME: we can make this parse a lot nicer by, when an error is
39: * encountered in a layout key, bailing to the next key (i.e. to the
40: * next whitespace then continuing).
41: */
42:
1.2 kristaps 43: #define KEYS_MAX 11
1.1 kristaps 44:
45: static const struct tbl_phrase keys[KEYS_MAX] = {
46: { 'c', TBL_CELL_CENTRE },
47: { 'r', TBL_CELL_RIGHT },
48: { 'l', TBL_CELL_LEFT },
49: { 'n', TBL_CELL_NUMBER },
50: { 's', TBL_CELL_SPAN },
51: { 'a', TBL_CELL_LONG },
52: { '^', TBL_CELL_DOWN },
53: { '-', TBL_CELL_HORIZ },
54: { '_', TBL_CELL_HORIZ },
1.23 schwarze 55: { '=', TBL_CELL_DHORIZ }
1.1 kristaps 56: };
57:
1.26 schwarze 58: static int mods(struct tbl_node *, struct tbl_cell *,
1.5 kristaps 59: int, const char *, int *);
1.26 schwarze 60: static int cell(struct tbl_node *, struct tbl_row *,
1.5 kristaps 61: int, const char *, int *);
1.6 kristaps 62: static void row(struct tbl_node *, int, const char *, int *);
1.23 schwarze 63: static struct tbl_cell *cell_alloc(struct tbl_node *, struct tbl_row *,
64: enum tbl_cellt, int vert);
1.1 kristaps 65:
1.26 schwarze 66:
1.1 kristaps 67: static int
1.26 schwarze 68: mods(struct tbl_node *tbl, struct tbl_cell *cp,
1.1 kristaps 69: int ln, const char *p, int *pos)
70: {
71: char buf[5];
72: int i;
1.20 kristaps 73:
74: /* Not all types accept modifiers. */
75:
76: switch (cp->pos) {
1.26 schwarze 77: case TBL_CELL_DOWN:
1.20 kristaps 78: /* FALLTHROUGH */
1.26 schwarze 79: case TBL_CELL_HORIZ:
1.20 kristaps 80: /* FALLTHROUGH */
1.26 schwarze 81: case TBL_CELL_DHORIZ:
1.20 kristaps 82: return(1);
83: default:
84: break;
85: }
1.1 kristaps 86:
87: mod:
1.26 schwarze 88: /*
1.1 kristaps 89: * XXX: since, at least for now, modifiers are non-conflicting
90: * (are separable by value, regardless of position), we let
91: * modifiers come in any order. The existing tbl doesn't let
92: * this happen.
93: */
94: switch (p[*pos]) {
1.26 schwarze 95: case '\0':
1.1 kristaps 96: /* FALLTHROUGH */
1.26 schwarze 97: case ' ':
1.1 kristaps 98: /* FALLTHROUGH */
1.26 schwarze 99: case '\t':
1.1 kristaps 100: /* FALLTHROUGH */
1.26 schwarze 101: case ',':
1.1 kristaps 102: /* FALLTHROUGH */
1.26 schwarze 103: case '.':
1.25 schwarze 104: /* FALLTHROUGH */
1.26 schwarze 105: case '|':
1.1 kristaps 106: return(1);
107: default:
108: break;
1.12 kristaps 109: }
110:
111: /* Throw away parenthesised expression. */
112:
113: if ('(' == p[*pos]) {
114: (*pos)++;
115: while (p[*pos] && ')' != p[*pos])
116: (*pos)++;
117: if (')' == p[*pos]) {
118: (*pos)++;
119: goto mod;
120: }
1.26 schwarze 121: mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
122: ln, *pos, NULL);
1.12 kristaps 123: return(0);
1.1 kristaps 124: }
125:
126: /* Parse numerical spacing from modifier string. */
127:
128: if (isdigit((unsigned char)p[*pos])) {
129: for (i = 0; i < 4; i++) {
130: if ( ! isdigit((unsigned char)p[*pos + i]))
131: break;
132: buf[i] = p[*pos + i];
133: }
134: buf[i] = '\0';
135:
136: /* No greater than 4 digits. */
137:
138: if (4 == i) {
1.26 schwarze 139: mandoc_msg(MANDOCERR_TBLLAYOUT,
140: tbl->parse, ln, *pos, NULL);
1.1 kristaps 141: return(0);
142: }
143:
144: *pos += i;
1.15 kristaps 145: cp->spacing = (size_t)atoi(buf);
1.1 kristaps 146:
147: goto mod;
148: /* NOTREACHED */
1.26 schwarze 149: }
1.1 kristaps 150:
151: /* TODO: GNU has many more extensions. */
152:
1.13 joerg 153: switch (tolower((unsigned char)p[(*pos)++])) {
1.26 schwarze 154: case 'z':
1.1 kristaps 155: cp->flags |= TBL_CELL_WIGN;
156: goto mod;
1.26 schwarze 157: case 'u':
1.1 kristaps 158: cp->flags |= TBL_CELL_UP;
159: goto mod;
1.26 schwarze 160: case 'e':
1.1 kristaps 161: cp->flags |= TBL_CELL_EQUAL;
162: goto mod;
1.26 schwarze 163: case 't':
1.1 kristaps 164: cp->flags |= TBL_CELL_TALIGN;
165: goto mod;
1.26 schwarze 166: case 'd':
1.1 kristaps 167: cp->flags |= TBL_CELL_BALIGN;
1.10 schwarze 168: goto mod;
1.26 schwarze 169: case 'w': /* XXX for now, ignore minimal column width */
1.29 ! schwarze 170: goto mod;
! 171: case 'x':
! 172: cp->flags |= TBL_CELL_WMAX;
1.1 kristaps 173: goto mod;
1.26 schwarze 174: case 'f':
1.2 kristaps 175: break;
1.26 schwarze 176: case 'r':
1.21 kristaps 177: /* FALLTHROUGH */
1.26 schwarze 178: case 'b':
1.1 kristaps 179: /* FALLTHROUGH */
1.26 schwarze 180: case 'i':
1.2 kristaps 181: (*pos)--;
1.1 kristaps 182: break;
183: default:
1.17 kristaps 184: mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
1.26 schwarze 185: ln, *pos - 1, NULL);
1.1 kristaps 186: return(0);
187: }
188:
1.13 joerg 189: switch (tolower((unsigned char)p[(*pos)++])) {
1.26 schwarze 190: case '3':
1.21 kristaps 191: /* FALLTHROUGH */
1.26 schwarze 192: case 'b':
1.1 kristaps 193: cp->flags |= TBL_CELL_BOLD;
194: goto mod;
1.26 schwarze 195: case '2':
1.21 kristaps 196: /* FALLTHROUGH */
1.26 schwarze 197: case 'i':
1.1 kristaps 198: cp->flags |= TBL_CELL_ITALIC;
1.21 kristaps 199: goto mod;
1.26 schwarze 200: case '1':
1.21 kristaps 201: /* FALLTHROUGH */
1.26 schwarze 202: case 'r':
1.1 kristaps 203: goto mod;
204: default:
205: break;
1.28 schwarze 206: }
207: if (isalnum((unsigned char)p[*pos - 1])) {
208: mandoc_vmsg(MANDOCERR_FT_BAD, tbl->parse,
209: ln, *pos - 1, "TS f%c", p[*pos - 1]);
210: goto mod;
1.1 kristaps 211: }
212:
1.17 kristaps 213: mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
1.26 schwarze 214: ln, *pos - 1, NULL);
1.1 kristaps 215: return(0);
216: }
217:
218: static int
1.26 schwarze 219: cell(struct tbl_node *tbl, struct tbl_row *rp,
1.1 kristaps 220: int ln, const char *p, int *pos)
221: {
1.23 schwarze 222: int vert, i;
1.1 kristaps 223: enum tbl_cellt c;
224:
1.23 schwarze 225: /* Handle vertical lines. */
226:
227: for (vert = 0; '|' == p[*pos]; ++*pos)
228: vert++;
229: while (' ' == p[*pos])
230: (*pos)++;
1.25 schwarze 231:
232: /* Handle trailing vertical lines */
233:
234: if ('.' == p[*pos] || '\0' == p[*pos]) {
235: rp->vert = vert;
236: return(1);
237: }
1.23 schwarze 238:
239: /* Parse the column position (`c', `l', `r', ...). */
1.1 kristaps 240:
241: for (i = 0; i < KEYS_MAX; i++)
1.13 joerg 242: if (tolower((unsigned char)p[*pos]) == keys[i].name)
1.1 kristaps 243: break;
244:
245: if (KEYS_MAX == i) {
1.26 schwarze 246: mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
247: ln, *pos, NULL);
1.1 kristaps 248: return(0);
249: }
250:
1.11 kristaps 251: c = keys[i].key;
252:
253: /*
254: * If a span cell is found first, raise a warning and abort the
1.14 kristaps 255: * parse. If a span cell is found and the last layout element
256: * isn't a "normal" layout, bail.
257: *
258: * FIXME: recover from this somehow?
1.11 kristaps 259: */
260:
1.14 kristaps 261: if (TBL_CELL_SPAN == c) {
262: if (NULL == rp->first) {
1.17 kristaps 263: mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse,
1.26 schwarze 264: ln, *pos, NULL);
1.14 kristaps 265: return(0);
266: } else if (rp->last)
267: switch (rp->last->pos) {
1.26 schwarze 268: case TBL_CELL_HORIZ:
269: /* FALLTHROUGH */
270: case TBL_CELL_DHORIZ:
271: mandoc_msg(MANDOCERR_TBLLAYOUT,
272: tbl->parse, ln, *pos, NULL);
1.14 kristaps 273: return(0);
274: default:
275: break;
276: }
1.16 kristaps 277: }
278:
279: /*
280: * If a vertical spanner is found, we may not be in the first
281: * row.
282: */
283:
284: if (TBL_CELL_DOWN == c && rp == tbl->first_row) {
1.17 kristaps 285: mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse, ln, *pos, NULL);
1.16 kristaps 286: return(0);
1.11 kristaps 287: }
288:
1.1 kristaps 289: (*pos)++;
290:
291: /* Disallow adjacent spacers. */
292:
1.23 schwarze 293: if (vert > 2) {
1.17 kristaps 294: mandoc_msg(MANDOCERR_TBLLAYOUT, tbl->parse, ln, *pos - 1, NULL);
1.1 kristaps 295: return(0);
296: }
297:
298: /* Allocate cell then parse its modifiers. */
299:
1.23 schwarze 300: return(mods(tbl, cell_alloc(tbl, rp, c, vert), ln, p, pos));
1.1 kristaps 301: }
302:
303: static void
1.6 kristaps 304: row(struct tbl_node *tbl, int ln, const char *p, int *pos)
1.1 kristaps 305: {
306: struct tbl_row *rp;
307:
308: row: /*
309: * EBNF describing this section:
310: *
311: * row ::= row_list [:space:]* [.]?[\n]
312: * row_list ::= [:space:]* row_elem row_tail
313: * row_tail ::= [:space:]*[,] row_list |
314: * epsilon
315: * row_elem ::= [\t\ ]*[:alpha:]+
316: */
317:
318: rp = mandoc_calloc(1, sizeof(struct tbl_row));
1.23 schwarze 319: if (tbl->last_row)
1.3 kristaps 320: tbl->last_row->next = rp;
1.23 schwarze 321: else
322: tbl->first_row = rp;
323: tbl->last_row = rp;
1.1 kristaps 324:
325: cell:
326: while (isspace((unsigned char)p[*pos]))
327: (*pos)++;
328:
329: /* Safely exit layout context. */
330:
331: if ('.' == p[*pos]) {
332: tbl->part = TBL_PART_DATA;
1.26 schwarze 333: if (NULL == tbl->first_row)
334: mandoc_msg(MANDOCERR_TBLNOLAYOUT,
335: tbl->parse, ln, *pos, NULL);
1.1 kristaps 336: (*pos)++;
337: return;
338: }
339:
340: /* End (and possibly restart) a row. */
341:
342: if (',' == p[*pos]) {
343: (*pos)++;
344: goto row;
345: } else if ('\0' == p[*pos])
346: return;
347:
348: if ( ! cell(tbl, rp, ln, p, pos))
349: return;
350:
351: goto cell;
352: /* NOTREACHED */
353: }
354:
355: int
1.6 kristaps 356: tbl_layout(struct tbl_node *tbl, int ln, const char *p)
1.1 kristaps 357: {
358: int pos;
359:
360: pos = 0;
361: row(tbl, ln, p, &pos);
362:
363: /* Always succeed. */
364: return(1);
365: }
1.5 kristaps 366:
367: static struct tbl_cell *
1.23 schwarze 368: cell_alloc(struct tbl_node *tbl, struct tbl_row *rp, enum tbl_cellt pos,
369: int vert)
1.5 kristaps 370: {
371: struct tbl_cell *p, *pp;
372: struct tbl_head *h, *hp;
373:
374: p = mandoc_calloc(1, sizeof(struct tbl_cell));
375:
376: if (NULL != (pp = rp->last)) {
1.23 schwarze 377: pp->next = p;
378: h = pp->head->next;
379: } else {
380: rp->first = p;
381: h = tbl->first_head;
382: }
383: rp->last = p;
1.5 kristaps 384:
385: p->pos = pos;
1.23 schwarze 386: p->vert = vert;
1.5 kristaps 387:
1.23 schwarze 388: /* Re-use header. */
1.5 kristaps 389:
390: if (h) {
1.23 schwarze 391: p->head = h;
392: return(p);
1.5 kristaps 393: }
394:
395: hp = mandoc_calloc(1, sizeof(struct tbl_head));
1.9 kristaps 396: hp->ident = tbl->opts.cols++;
1.23 schwarze 397: hp->vert = vert;
1.5 kristaps 398:
399: if (tbl->last_head) {
400: hp->prev = tbl->last_head;
401: tbl->last_head->next = hp;
402: } else
1.23 schwarze 403: tbl->first_head = hp;
404: tbl->last_head = hp;
1.5 kristaps 405:
406: p->head = hp;
407: return(p);
408: }
CVSweb