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