Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.63
1.63 ! schwarze 1: /* $OpenBSD: man_macro.c,v 1.62 2015/03/20 14:47:20 schwarze Exp $ */
1.1 kristaps 2: /*
1.29 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.55 schwarze 4: * Copyright (c) 2012, 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.42 schwarze 5: * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
1.1 kristaps 6: *
7: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 8: * purpose with or without fee is hereby granted, provided that the above
9: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 10: *
1.63 ! schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.63 ! schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 14: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 18: */
1.51 schwarze 19: #include <sys/types.h>
20:
1.1 kristaps 21: #include <assert.h>
22: #include <ctype.h>
23: #include <stdlib.h>
24: #include <string.h>
25:
1.63 ! schwarze 26: #include "mandoc.h"
! 27: #include "roff.h"
1.29 schwarze 28: #include "man.h"
29: #include "libmandoc.h"
1.1 kristaps 30: #include "libman.h"
31:
1.12 schwarze 32: enum rew {
33: REW_REWIND,
34: REW_NOHALT,
1.13 schwarze 35: REW_HALT
1.12 schwarze 36: };
1.6 schwarze 37:
1.53 schwarze 38: static void blk_close(MACRO_PROT_ARGS);
39: static void blk_exp(MACRO_PROT_ARGS);
40: static void blk_imp(MACRO_PROT_ARGS);
41: static void in_line_eoln(MACRO_PROT_ARGS);
1.45 schwarze 42: static int man_args(struct man *, int,
1.29 schwarze 43: int *, char *, char **);
1.6 schwarze 44:
1.63 ! schwarze 45: static void rew_scope(enum roff_type,
1.12 schwarze 46: struct man *, enum mant);
1.63 ! schwarze 47: static enum rew rew_dohalt(enum mant, enum roff_type,
1.6 schwarze 48: const struct man_node *);
1.63 ! schwarze 49: static enum rew rew_block(enum mant, enum roff_type,
1.7 schwarze 50: const struct man_node *);
1.6 schwarze 51:
52: const struct man_macro __man_macros[MAN_MAX] = {
1.11 schwarze 53: { in_line_eoln, MAN_NSCOPED }, /* br */
1.32 schwarze 54: { in_line_eoln, MAN_BSCOPE }, /* TH */
55: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
56: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
1.61 schwarze 57: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TP */
1.32 schwarze 58: { blk_imp, MAN_BSCOPE }, /* LP */
59: { blk_imp, MAN_BSCOPE }, /* PP */
60: { blk_imp, MAN_BSCOPE }, /* P */
61: { blk_imp, MAN_BSCOPE }, /* IP */
62: { blk_imp, MAN_BSCOPE }, /* HP */
1.52 schwarze 63: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
64: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
1.6 schwarze 65: { in_line_eoln, 0 }, /* BI */
66: { in_line_eoln, 0 }, /* IB */
67: { in_line_eoln, 0 }, /* BR */
68: { in_line_eoln, 0 }, /* RB */
1.52 schwarze 69: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
70: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
71: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
1.6 schwarze 72: { in_line_eoln, 0 }, /* IR */
73: { in_line_eoln, 0 }, /* RI */
1.11 schwarze 74: { in_line_eoln, MAN_NSCOPED }, /* sp */
1.32 schwarze 75: { in_line_eoln, MAN_BSCOPE }, /* nf */
76: { in_line_eoln, MAN_BSCOPE }, /* fi */
1.54 schwarze 77: { blk_close, MAN_BSCOPE }, /* RE */
1.61 schwarze 78: { blk_exp, MAN_BSCOPE }, /* RS */
1.7 schwarze 79: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 80: { in_line_eoln, 0 }, /* UC */
1.62 schwarze 81: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.18 schwarze 82: { in_line_eoln, 0 }, /* AT */
1.20 schwarze 83: { in_line_eoln, 0 }, /* in */
1.22 schwarze 84: { in_line_eoln, 0 }, /* ft */
1.34 schwarze 85: { in_line_eoln, 0 }, /* OP */
1.35 schwarze 86: { in_line_eoln, MAN_BSCOPE }, /* EX */
87: { in_line_eoln, MAN_BSCOPE }, /* EE */
1.61 schwarze 88: { blk_exp, MAN_BSCOPE }, /* UR */
1.54 schwarze 89: { blk_close, MAN_BSCOPE }, /* UE */
1.44 schwarze 90: { in_line_eoln, 0 }, /* ll */
1.6 schwarze 91: };
1.1 kristaps 92:
1.6 schwarze 93: const struct man_macro * const man_macros = __man_macros;
1.1 kristaps 94:
95:
1.53 schwarze 96: void
1.46 schwarze 97: man_unscope(struct man *man, const struct man_node *to)
1.1 kristaps 98: {
1.27 schwarze 99: struct man_node *n;
1.1 kristaps 100:
1.46 schwarze 101: to = to->parent;
102: n = man->last;
103: while (n != to) {
1.50 schwarze 104:
105: /* Reached the end of the document? */
106:
107: if (to == NULL && ! (n->flags & MAN_VALID)) {
108: if (man->flags & (MAN_BLINE | MAN_ELINE) &&
109: man_macros[n->tok].flags & MAN_SCOPED) {
110: mandoc_vmsg(MANDOCERR_BLK_LINE,
111: man->parse, n->line, n->pos,
112: "EOF breaks %s",
113: man_macronames[n->tok]);
114: if (man->flags & MAN_ELINE)
115: man->flags &= ~MAN_ELINE;
116: else {
1.63 ! schwarze 117: assert(n->type == ROFFT_HEAD);
1.50 schwarze 118: n = n->parent;
119: man->flags &= ~MAN_BLINE;
120: }
121: man->last = n;
122: n = n->parent;
123: man_node_delete(man, man->last);
124: continue;
125: }
1.63 ! schwarze 126: if (n->type == ROFFT_BLOCK &&
1.61 schwarze 127: man_macros[n->tok].fp == blk_exp)
1.50 schwarze 128: mandoc_msg(MANDOCERR_BLK_NOEND,
129: man->parse, n->line, n->pos,
130: man_macronames[n->tok]);
131: }
132:
1.27 schwarze 133: /*
1.46 schwarze 134: * We might delete the man->last node
135: * in the post-validation phase.
136: * Save a pointer to the parent such that
137: * we know where to continue the iteration.
1.27 schwarze 138: */
1.51 schwarze 139:
1.46 schwarze 140: man->last = n;
141: n = n->parent;
1.53 schwarze 142: man_valid_post(man);
1.6 schwarze 143: }
1.51 schwarze 144:
145: /*
146: * If we ended up at the parent of the node we were
147: * supposed to rewind to, that means the target node
148: * got deleted, so add the next node we parse as a child
149: * of the parent instead of as a sibling of the target.
150: */
151:
152: man->next = (man->last == to) ?
153: MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
1.6 schwarze 154: }
1.1 kristaps 155:
1.12 schwarze 156: static enum rew
1.63 ! schwarze 157: rew_block(enum mant ntok, enum roff_type type, const struct man_node *n)
1.7 schwarze 158: {
159:
1.63 ! schwarze 160: if (type == ROFFT_BLOCK && n->parent->tok == ntok &&
! 161: n->parent->type == ROFFT_BODY)
1.7 schwarze 162: return(REW_REWIND);
163: return(ntok == n->tok ? REW_HALT : REW_NOHALT);
164: }
165:
1.6 schwarze 166: /*
167: * There are three scope levels: scoped to the root (all), scoped to the
168: * section (all less sections), and scoped to subsections (all less
169: * sections and subsections).
170: */
1.45 schwarze 171: static enum rew
1.63 ! schwarze 172: rew_dohalt(enum mant tok, enum roff_type type, const struct man_node *n)
1.6 schwarze 173: {
1.12 schwarze 174: enum rew c;
1.1 kristaps 175:
1.13 schwarze 176: /* We cannot progress beyond the root ever. */
1.63 ! schwarze 177: if (n->type == ROFFT_ROOT)
1.6 schwarze 178: return(REW_HALT);
1.13 schwarze 179:
1.6 schwarze 180: assert(n->parent);
1.13 schwarze 181:
182: /* Normal nodes shouldn't go to the level of the root. */
1.63 ! schwarze 183: if (n->parent->type == ROFFT_ROOT)
1.6 schwarze 184: return(REW_REWIND);
1.13 schwarze 185:
186: /* Already-validated nodes should be closed out. */
1.6 schwarze 187: if (MAN_VALID & n->flags)
188: return(REW_NOHALT);
189:
1.13 schwarze 190: /* First: rewind to ourselves. */
1.36 schwarze 191: if (type == n->type && tok == n->tok) {
1.61 schwarze 192: if (man_macros[n->tok].fp == blk_exp)
1.36 schwarze 193: return(REW_HALT);
194: else
195: return(REW_REWIND);
196: }
1.7 schwarze 197:
1.45 schwarze 198: /*
1.13 schwarze 199: * Next follow the implicit scope-smashings as defined by man.7:
200: * section, sub-section, etc.
201: */
202:
1.6 schwarze 203: switch (tok) {
1.45 schwarze 204: case MAN_SH:
1.6 schwarze 205: break;
1.45 schwarze 206: case MAN_SS:
1.6 schwarze 207: /* Rewind to a section, if a block. */
1.7 schwarze 208: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
209: return(c);
210: break;
1.45 schwarze 211: case MAN_RS:
1.36 schwarze 212: /* Preserve empty paragraphs before RS. */
213: if (0 == n->nchild && (MAN_P == n->tok ||
214: MAN_PP == n->tok || MAN_LP == n->tok))
215: return(REW_HALT);
1.7 schwarze 216: /* Rewind to a subsection, if a block. */
217: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
218: return(c);
219: /* Rewind to a section, if a block. */
220: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
221: return(c);
1.6 schwarze 222: break;
223: default:
1.7 schwarze 224: /* Rewind to an offsetter, if a block. */
225: if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
226: return(c);
1.6 schwarze 227: /* Rewind to a subsection, if a block. */
1.7 schwarze 228: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
229: return(c);
1.6 schwarze 230: /* Rewind to a section, if a block. */
1.7 schwarze 231: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
232: return(c);
1.6 schwarze 233: break;
1.1 kristaps 234: }
235:
1.6 schwarze 236: return(REW_NOHALT);
237: }
1.1 kristaps 238:
1.6 schwarze 239: /*
240: * Rewinding entails ascending the parse tree until a coherent point,
241: * for example, the `SH' macro will close out any intervening `SS'
242: * scopes. When a scope is closed, it must be validated and actioned.
243: */
1.53 schwarze 244: static void
1.63 ! schwarze 245: rew_scope(enum roff_type type, struct man *man, enum mant tok)
1.6 schwarze 246: {
247: struct man_node *n;
1.12 schwarze 248: enum rew c;
1.1 kristaps 249:
1.38 schwarze 250: for (n = man->last; n; n = n->parent) {
1.45 schwarze 251: /*
1.6 schwarze 252: * Whether we should stop immediately (REW_HALT), stop
253: * and rewind until this point (REW_REWIND), or keep
254: * rewinding (REW_NOHALT).
255: */
256: c = rew_dohalt(tok, type, n);
257: if (REW_HALT == c)
1.53 schwarze 258: return;
1.6 schwarze 259: if (REW_REWIND == c)
1.1 kristaps 260: break;
261: }
262:
1.45 schwarze 263: /*
1.13 schwarze 264: * Rewind until the current point. Warn if we're a roff
265: * instruction that's mowing over explicit scopes.
266: */
1.6 schwarze 267:
1.53 schwarze 268: man_unscope(man, n);
1.6 schwarze 269: }
270:
1.1 kristaps 271:
1.12 schwarze 272: /*
273: * Close out a generic explicit macro.
274: */
1.53 schwarze 275: void
1.7 schwarze 276: blk_close(MACRO_PROT_ARGS)
277: {
1.45 schwarze 278: enum mant ntok;
1.7 schwarze 279: const struct man_node *nn;
1.55 schwarze 280: char *p;
281: int nrew, target;
1.7 schwarze 282:
1.55 schwarze 283: nrew = 1;
1.7 schwarze 284: switch (tok) {
1.45 schwarze 285: case MAN_RE:
1.7 schwarze 286: ntok = MAN_RS;
1.55 schwarze 287: if ( ! man_args(man, line, pos, buf, &p))
288: break;
289: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 ! schwarze 290: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.55 schwarze 291: nrew++;
292: target = strtol(p, &p, 10);
293: if (*p != '\0')
294: mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
295: line, p - buf, "RE ... %s", p);
296: if (target == 0)
297: target = 1;
298: nrew -= target;
299: if (nrew < 1) {
300: mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse,
301: line, ppos, "RE %d", target);
302: return;
303: }
1.39 schwarze 304: break;
1.45 schwarze 305: case MAN_UE:
1.39 schwarze 306: ntok = MAN_UR;
1.7 schwarze 307: break;
308: default:
309: abort();
310: /* NOTREACHED */
311: }
312:
1.38 schwarze 313: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 ! schwarze 314: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.7 schwarze 315: break;
316:
1.53 schwarze 317: if (nn == NULL) {
1.47 schwarze 318: mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
319: line, ppos, man_macronames[tok]);
1.63 ! schwarze 320: rew_scope(ROFFT_BLOCK, man, MAN_PP);
1.57 schwarze 321: } else {
322: line = man->last->line;
323: ppos = man->last->pos;
324: ntok = man->last->tok;
1.46 schwarze 325: man_unscope(man, nn);
1.57 schwarze 326:
327: /* Move a trailing paragraph behind the block. */
328:
329: if (ntok == MAN_LP || ntok == MAN_PP || ntok == MAN_P) {
330: *pos = strlen(buf);
331: blk_imp(man, ntok, line, ppos, pos, buf);
332: }
333: }
1.7 schwarze 334: }
335:
1.53 schwarze 336: void
1.12 schwarze 337: blk_exp(MACRO_PROT_ARGS)
338: {
1.60 schwarze 339: struct man_node *head;
340: char *p;
1.29 schwarze 341: int la;
1.12 schwarze 342:
1.63 ! schwarze 343: rew_scope(ROFFT_BLOCK, man, tok);
1.53 schwarze 344: man_block_alloc(man, line, ppos, tok);
345: man_head_alloc(man, line, ppos, tok);
1.60 schwarze 346: head = man->last;
1.12 schwarze 347:
1.60 schwarze 348: la = *pos;
349: if (man_args(man, line, pos, buf, &p))
1.53 schwarze 350: man_word_alloc(man, line, la, p);
1.12 schwarze 351:
1.60 schwarze 352: if (buf[*pos] != '\0')
353: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
354: man->parse, line, *pos, "%s ... %s",
355: man_macronames[tok], buf + *pos);
1.36 schwarze 356:
1.60 schwarze 357: man_unscope(man, head);
1.53 schwarze 358: man_body_alloc(man, line, ppos, tok);
1.12 schwarze 359: }
360:
1.6 schwarze 361: /*
1.63 ! schwarze 362: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
! 363: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.6 schwarze 364: * scopes, such as `SH' closing out an `SS', are defined in the rew
365: * routines.
366: */
1.53 schwarze 367: void
1.6 schwarze 368: blk_imp(MACRO_PROT_ARGS)
369: {
1.29 schwarze 370: int la;
1.6 schwarze 371: char *p;
1.7 schwarze 372: struct man_node *n;
1.6 schwarze 373:
1.63 ! schwarze 374: rew_scope(ROFFT_BODY, man, tok);
! 375: rew_scope(ROFFT_BLOCK, man, tok);
1.53 schwarze 376: man_block_alloc(man, line, ppos, tok);
377: man_head_alloc(man, line, ppos, tok);
1.38 schwarze 378: n = man->last;
1.7 schwarze 379:
1.6 schwarze 380: /* Add line arguments. */
1.1 kristaps 381:
1.6 schwarze 382: for (;;) {
383: la = *pos;
1.38 schwarze 384: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 385: break;
1.53 schwarze 386: man_word_alloc(man, line, la, p);
1.1 kristaps 387: }
388:
1.61 schwarze 389: /*
390: * For macros having optional next-line scope,
391: * keep the head open if there were no arguments.
392: * For `TP', always keep the head open.
393: */
1.6 schwarze 394:
1.61 schwarze 395: if (man_macros[tok].flags & MAN_SCOPED &&
396: (tok == MAN_TP || n == man->last)) {
397: man->flags |= MAN_BLINE;
398: return;
1.7 schwarze 399: }
1.61 schwarze 400:
401: /* Close out the head and open the body. */
402:
1.63 ! schwarze 403: rew_scope(ROFFT_HEAD, man, tok);
1.53 schwarze 404: man_body_alloc(man, line, ppos, tok);
1.1 kristaps 405: }
406:
1.53 schwarze 407: void
1.6 schwarze 408: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 409: {
1.29 schwarze 410: int la;
1.6 schwarze 411: char *p;
412: struct man_node *n;
1.1 kristaps 413:
1.53 schwarze 414: man_elem_alloc(man, line, ppos, tok);
1.38 schwarze 415: n = man->last;
1.1 kristaps 416:
1.6 schwarze 417: for (;;) {
1.58 schwarze 418: if (buf[*pos] != '\0' && (tok == MAN_br ||
419: tok == MAN_fi || tok == MAN_nf)) {
420: mandoc_vmsg(MANDOCERR_ARG_SKIP,
421: man->parse, line, *pos, "%s %s",
1.59 schwarze 422: man_macronames[tok], buf + *pos);
423: break;
424: }
425: if (buf[*pos] != '\0' && man->last != n &&
426: (tok == MAN_PD || tok == MAN_ft || tok == MAN_sp)) {
427: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
428: man->parse, line, *pos, "%s ... %s",
1.58 schwarze 429: man_macronames[tok], buf + *pos);
430: break;
431: }
1.6 schwarze 432: la = *pos;
1.38 schwarze 433: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 434: break;
1.52 schwarze 435: if (man_macros[tok].flags & MAN_JOIN &&
1.63 ! schwarze 436: man->last->type == ROFFT_TEXT)
1.52 schwarze 437: man_word_append(man, p);
1.53 schwarze 438: else
439: man_word_alloc(man, line, la, p);
1.6 schwarze 440: }
1.41 schwarze 441:
442: /*
443: * Append MAN_EOS in case the last snipped argument
444: * ends with a dot, e.g. `.IR syslog (3).'
445: */
446:
447: if (n != man->last &&
1.43 schwarze 448: mandoc_eos(man->last->string, strlen(man->last->string)))
1.41 schwarze 449: man->last->flags |= MAN_EOS;
1.1 kristaps 450:
1.11 schwarze 451: /*
452: * If no arguments are specified and this is MAN_SCOPED (i.e.,
453: * next-line scoped), then set our mode to indicate that we're
454: * waiting for terms to load into our context.
455: */
456:
1.53 schwarze 457: if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
458: assert( ! (man_macros[tok].flags & MAN_NSCOPED));
1.38 schwarze 459: man->flags |= MAN_ELINE;
1.53 schwarze 460: return;
1.11 schwarze 461: }
1.31 schwarze 462:
1.63 ! schwarze 463: assert(man->last->type != ROFFT_ROOT);
1.38 schwarze 464: man->next = MAN_NEXT_SIBLING;
1.45 schwarze 465:
1.6 schwarze 466: /*
1.11 schwarze 467: * Rewind our element scope. Note that when TH is pruned, we'll
468: * be back at the root, so make sure that we don't clobber as
469: * its sibling.
1.6 schwarze 470: */
1.1 kristaps 471:
1.38 schwarze 472: for ( ; man->last; man->last = man->last->parent) {
473: if (man->last == n)
1.6 schwarze 474: break;
1.63 ! schwarze 475: if (man->last->type == ROFFT_ROOT)
1.6 schwarze 476: break;
1.53 schwarze 477: man_valid_post(man);
1.6 schwarze 478: }
1.1 kristaps 479:
1.38 schwarze 480: assert(man->last);
1.1 kristaps 481:
482: /*
1.45 schwarze 483: * Same here regarding whether we're back at the root.
1.1 kristaps 484: */
485:
1.63 ! schwarze 486: if (man->last->type != ROFFT_ROOT)
1.53 schwarze 487: man_valid_post(man);
1.6 schwarze 488: }
1.1 kristaps 489:
490:
1.53 schwarze 491: void
1.38 schwarze 492: man_macroend(struct man *man)
1.6 schwarze 493: {
1.1 kristaps 494:
1.53 schwarze 495: man_unscope(man, man->first);
1.6 schwarze 496: }
1.1 kristaps 497:
1.29 schwarze 498: static int
1.38 schwarze 499: man_args(struct man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 500: {
501: char *start;
502:
503: assert(*pos);
504: *v = start = buf + *pos;
505: assert(' ' != *start);
506:
507: if ('\0' == *start)
508: return(0);
509:
1.38 schwarze 510: *v = mandoc_getarg(man->parse, v, line, pos);
1.29 schwarze 511: return(1);
512: }