Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.54
1.54 ! schwarze 1: /* $OpenBSD: man_macro.c,v 1.53 2014/11/28 05:51:29 schwarze Exp $ */
1.1 kristaps 2: /*
1.29 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.52 schwarze 4: * Copyright (c) 2012, 2013, 2014 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 }, /* na */
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.37 schwarze 78: { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */
1.7 schwarze 79: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 80: { in_line_eoln, 0 }, /* UC */
1.9 schwarze 81: { in_line_eoln, 0 }, /* 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.39 schwarze 88: { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* 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 {
117: assert(n->type == MAN_HEAD);
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: }
126: if (n->type == MAN_BLOCK &&
127: man_macros[n->tok].flags & MAN_EXPLICIT)
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
157: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.7 schwarze 158: {
159:
1.53 schwarze 160: if (type == MAN_BLOCK && ntok == n->parent->tok &&
161: n->parent->type == MAN_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.12 schwarze 172: rew_dohalt(enum mant tok, enum man_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.6 schwarze 177: if (MAN_ROOT == n->type)
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.6 schwarze 183: if (MAN_ROOT == n->parent->type)
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) {
192: if (MAN_EXPLICIT & man_macros[n->tok].flags)
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.38 schwarze 245: rew_scope(enum man_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;
280:
281: switch (tok) {
1.45 schwarze 282: case MAN_RE:
1.7 schwarze 283: ntok = MAN_RS;
1.39 schwarze 284: break;
1.45 schwarze 285: case MAN_UE:
1.39 schwarze 286: ntok = MAN_UR;
1.7 schwarze 287: break;
288: default:
289: abort();
290: /* NOTREACHED */
291: }
292:
1.38 schwarze 293: for (nn = man->last->parent; nn; nn = nn->parent)
1.53 schwarze 294: if (nn->tok == ntok && nn->type == MAN_BLOCK)
1.7 schwarze 295: break;
296:
1.53 schwarze 297: if (nn == NULL) {
1.47 schwarze 298: mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
299: line, ppos, man_macronames[tok]);
1.53 schwarze 300: rew_scope(MAN_BLOCK, man, MAN_PP);
1.45 schwarze 301: } else
1.46 schwarze 302: man_unscope(man, nn);
1.7 schwarze 303: }
304:
1.53 schwarze 305: void
1.12 schwarze 306: blk_exp(MACRO_PROT_ARGS)
307: {
1.36 schwarze 308: struct man_node *n;
1.29 schwarze 309: int la;
1.12 schwarze 310: char *p;
311:
1.53 schwarze 312: rew_scope(MAN_BLOCK, man, tok);
313: man_block_alloc(man, line, ppos, tok);
314: man_head_alloc(man, line, ppos, tok);
1.12 schwarze 315:
316: for (;;) {
317: la = *pos;
1.38 schwarze 318: if ( ! man_args(man, line, pos, buf, &p))
1.12 schwarze 319: break;
1.53 schwarze 320: man_word_alloc(man, line, la, p);
1.12 schwarze 321: }
322:
1.38 schwarze 323: assert(man);
1.12 schwarze 324: assert(tok != MAN_MAX);
325:
1.53 schwarze 326: for (n = man->last; n; n = n->parent)
327: if (n->tok == tok) {
328: assert(n->type == MAN_HEAD);
329: man_unscope(man, n);
330: break;
331: }
1.36 schwarze 332:
1.53 schwarze 333: man_body_alloc(man, line, ppos, tok);
1.12 schwarze 334: }
335:
1.6 schwarze 336: /*
337: * Parse an implicit-block macro. These contain a MAN_HEAD and a
338: * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
339: * scopes, such as `SH' closing out an `SS', are defined in the rew
340: * routines.
341: */
1.53 schwarze 342: void
1.6 schwarze 343: blk_imp(MACRO_PROT_ARGS)
344: {
1.29 schwarze 345: int la;
1.6 schwarze 346: char *p;
1.7 schwarze 347: struct man_node *n;
1.6 schwarze 348:
1.53 schwarze 349: rew_scope(MAN_BODY, man, tok);
350: rew_scope(MAN_BLOCK, man, tok);
351: man_block_alloc(man, line, ppos, tok);
352: man_head_alloc(man, line, ppos, tok);
1.38 schwarze 353: n = man->last;
1.7 schwarze 354:
1.6 schwarze 355: /* Add line arguments. */
1.1 kristaps 356:
1.6 schwarze 357: for (;;) {
358: la = *pos;
1.38 schwarze 359: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 360: break;
1.53 schwarze 361: man_word_alloc(man, line, la, p);
1.1 kristaps 362: }
363:
1.6 schwarze 364: /* Close out head and open body (unless MAN_SCOPE). */
365:
1.53 schwarze 366: if (man_macros[tok].flags & MAN_SCOPED) {
1.7 schwarze 367: /* If we're forcing scope (`TP'), keep it open. */
1.53 schwarze 368: if (man_macros[tok].flags & MAN_FSCOPED) {
1.38 schwarze 369: man->flags |= MAN_BLINE;
1.53 schwarze 370: return;
1.38 schwarze 371: } else if (n == man->last) {
372: man->flags |= MAN_BLINE;
1.53 schwarze 373: return;
1.7 schwarze 374: }
375: }
1.53 schwarze 376: rew_scope(MAN_HEAD, man, tok);
377: man_body_alloc(man, line, ppos, tok);
1.1 kristaps 378: }
379:
1.53 schwarze 380: void
1.6 schwarze 381: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 382: {
1.29 schwarze 383: int la;
1.6 schwarze 384: char *p;
385: struct man_node *n;
1.1 kristaps 386:
1.53 schwarze 387: man_elem_alloc(man, line, ppos, tok);
1.38 schwarze 388: n = man->last;
1.1 kristaps 389:
1.6 schwarze 390: for (;;) {
391: la = *pos;
1.38 schwarze 392: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 393: break;
1.52 schwarze 394: if (man_macros[tok].flags & MAN_JOIN &&
395: man->last->type == MAN_TEXT)
396: man_word_append(man, p);
1.53 schwarze 397: else
398: man_word_alloc(man, line, la, p);
1.6 schwarze 399: }
1.41 schwarze 400:
401: /*
402: * Append MAN_EOS in case the last snipped argument
403: * ends with a dot, e.g. `.IR syslog (3).'
404: */
405:
406: if (n != man->last &&
1.43 schwarze 407: mandoc_eos(man->last->string, strlen(man->last->string)))
1.41 schwarze 408: man->last->flags |= MAN_EOS;
1.1 kristaps 409:
1.11 schwarze 410: /*
411: * If no arguments are specified and this is MAN_SCOPED (i.e.,
412: * next-line scoped), then set our mode to indicate that we're
413: * waiting for terms to load into our context.
414: */
415:
1.53 schwarze 416: if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
417: assert( ! (man_macros[tok].flags & MAN_NSCOPED));
1.38 schwarze 418: man->flags |= MAN_ELINE;
1.53 schwarze 419: return;
1.11 schwarze 420: }
1.31 schwarze 421:
1.53 schwarze 422: assert(man->last->type != MAN_ROOT);
1.38 schwarze 423: man->next = MAN_NEXT_SIBLING;
1.45 schwarze 424:
1.6 schwarze 425: /*
1.11 schwarze 426: * Rewind our element scope. Note that when TH is pruned, we'll
427: * be back at the root, so make sure that we don't clobber as
428: * its sibling.
1.6 schwarze 429: */
1.1 kristaps 430:
1.38 schwarze 431: for ( ; man->last; man->last = man->last->parent) {
432: if (man->last == n)
1.6 schwarze 433: break;
1.38 schwarze 434: if (man->last->type == MAN_ROOT)
1.6 schwarze 435: break;
1.53 schwarze 436: man_valid_post(man);
1.6 schwarze 437: }
1.1 kristaps 438:
1.38 schwarze 439: assert(man->last);
1.1 kristaps 440:
441: /*
1.45 schwarze 442: * Same here regarding whether we're back at the root.
1.1 kristaps 443: */
444:
1.53 schwarze 445: if (man->last->type != MAN_ROOT)
446: man_valid_post(man);
1.6 schwarze 447: }
1.1 kristaps 448:
449:
1.53 schwarze 450: void
1.38 schwarze 451: man_macroend(struct man *man)
1.6 schwarze 452: {
1.1 kristaps 453:
1.53 schwarze 454: man_unscope(man, man->first);
1.6 schwarze 455: }
1.1 kristaps 456:
1.29 schwarze 457: static int
1.38 schwarze 458: man_args(struct man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 459: {
460: char *start;
461:
462: assert(*pos);
463: *v = start = buf + *pos;
464: assert(' ' != *start);
465:
466: if ('\0' == *start)
467: return(0);
468:
1.38 schwarze 469: *v = mandoc_getarg(man->parse, v, line, pos);
1.29 schwarze 470: return(1);
471: }
![[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