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