Annotation of mandoc/man_macro.c, Revision 1.57
1.57 ! kristaps 1: /* $Id: man_macro.c,v 1.56 2011/03/17 11:56:17 kristaps Exp $ */
1.1 kristaps 2: /*
1.50 schwarze 3: * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.14 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.14 kristaps 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 16: */
1.30 kristaps 17: #ifdef HAVE_CONFIG_H
18: #include "config.h"
19: #endif
20:
1.1 kristaps 21: #include <assert.h>
22: #include <ctype.h>
23: #include <stdlib.h>
24: #include <string.h>
25:
1.46 kristaps 26: #include "mandoc.h"
1.57 ! kristaps 27: #include "libmandoc.h"
1.1 kristaps 28: #include "libman.h"
29:
1.34 kristaps 30: enum rew {
31: REW_REWIND,
32: REW_NOHALT,
1.40 kristaps 33: REW_HALT
1.34 kristaps 34: };
1.19 kristaps 35:
1.35 kristaps 36: static int blk_close(MACRO_PROT_ARGS);
37: static int blk_exp(MACRO_PROT_ARGS);
38: static int blk_imp(MACRO_PROT_ARGS);
1.19 kristaps 39: static int in_line_eoln(MACRO_PROT_ARGS);
40:
1.33 kristaps 41: static int rew_scope(enum man_type,
42: struct man *, enum mant);
1.34 kristaps 43: static enum rew rew_dohalt(enum mant, enum man_type,
1.19 kristaps 44: const struct man_node *);
1.34 kristaps 45: static enum rew rew_block(enum mant, enum man_type,
1.21 kristaps 46: const struct man_node *);
1.56 kristaps 47: static void rew_warn(struct man *,
1.46 kristaps 48: struct man_node *, enum mandocerr);
1.19 kristaps 49:
50: const struct man_macro __man_macros[MAN_MAX] = {
1.31 kristaps 51: { in_line_eoln, MAN_NSCOPED }, /* br */
1.19 kristaps 52: { in_line_eoln, 0 }, /* TH */
1.24 kristaps 53: { blk_imp, MAN_SCOPED }, /* SH */
54: { blk_imp, MAN_SCOPED }, /* SS */
1.27 kristaps 55: { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */
1.19 kristaps 56: { blk_imp, 0 }, /* LP */
57: { blk_imp, 0 }, /* PP */
58: { blk_imp, 0 }, /* P */
59: { blk_imp, 0 }, /* IP */
60: { blk_imp, 0 }, /* HP */
61: { in_line_eoln, MAN_SCOPED }, /* SM */
62: { in_line_eoln, MAN_SCOPED }, /* SB */
63: { in_line_eoln, 0 }, /* BI */
64: { in_line_eoln, 0 }, /* IB */
65: { in_line_eoln, 0 }, /* BR */
66: { in_line_eoln, 0 }, /* RB */
67: { in_line_eoln, MAN_SCOPED }, /* R */
68: { in_line_eoln, MAN_SCOPED }, /* B */
69: { in_line_eoln, MAN_SCOPED }, /* I */
70: { in_line_eoln, 0 }, /* IR */
71: { in_line_eoln, 0 }, /* RI */
1.31 kristaps 72: { in_line_eoln, MAN_NSCOPED }, /* na */
73: { in_line_eoln, MAN_NSCOPED }, /* sp */
1.19 kristaps 74: { in_line_eoln, 0 }, /* nf */
75: { in_line_eoln, 0 }, /* fi */
1.21 kristaps 76: { blk_close, 0 }, /* RE */
1.35 kristaps 77: { blk_exp, MAN_EXPLICIT }, /* RS */
1.23 kristaps 78: { in_line_eoln, 0 }, /* DT */
1.28 kristaps 79: { in_line_eoln, 0 }, /* UC */
1.29 kristaps 80: { in_line_eoln, 0 }, /* PD */
1.45 joerg 81: { in_line_eoln, 0 }, /* AT */
1.49 kristaps 82: { in_line_eoln, 0 }, /* in */
1.53 kristaps 83: { in_line_eoln, 0 }, /* ft */
1.19 kristaps 84: };
1.9 kristaps 85:
1.19 kristaps 86: const struct man_macro * const man_macros = __man_macros;
1.1 kristaps 87:
88:
1.38 kristaps 89: /*
90: * Warn when "n" is an explicit non-roff macro.
91: */
1.56 kristaps 92: static void
1.46 kristaps 93: rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
1.38 kristaps 94: {
95:
1.46 kristaps 96: if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
1.56 kristaps 97: return;
1.38 kristaps 98: if (MAN_VALID & n->flags)
1.56 kristaps 99: return;
1.38 kristaps 100: if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
1.56 kristaps 101: return;
102:
103: assert(er < MANDOCERR_FATAL);
104: man_nmsg(m, n, er);
1.38 kristaps 105: }
106:
107:
108: /*
1.46 kristaps 109: * Rewind scope. If a code "er" != MANDOCERR_MAX has been provided, it
110: * will be used if an explicit block scope is being closed out.
1.38 kristaps 111: */
1.3 kristaps 112: int
1.55 kristaps 113: man_unscope(struct man *m, const struct man_node *to,
1.46 kristaps 114: enum mandocerr er)
1.1 kristaps 115: {
1.55 kristaps 116: struct man_node *n;
1.1 kristaps 117:
1.55 kristaps 118: assert(to);
1.19 kristaps 119:
120: /* LINTED */
1.55 kristaps 121: while (m->last != to) {
122: /*
123: * Save the parent here, because we may delete the
124: * m->last node in the post-validation phase and reset
125: * it to m->last->parent, causing a step in the closing
126: * out to be lost.
127: */
128: n = m->last->parent;
1.56 kristaps 129: rew_warn(m, m->last, er);
1.19 kristaps 130: if ( ! man_valid_post(m))
131: return(0);
1.55 kristaps 132: m->last = n;
1.19 kristaps 133: assert(m->last);
134: }
135:
1.56 kristaps 136: rew_warn(m, m->last, er);
1.19 kristaps 137: if ( ! man_valid_post(m))
1.1 kristaps 138: return(0);
1.35 kristaps 139:
140: m->next = MAN_ROOT == m->last->type ?
141: MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
142:
143: return(1);
1.19 kristaps 144: }
1.1 kristaps 145:
146:
1.34 kristaps 147: static enum rew
1.33 kristaps 148: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.21 kristaps 149: {
150:
151: if (MAN_BLOCK == type && ntok == n->parent->tok &&
152: MAN_BODY == n->parent->type)
153: return(REW_REWIND);
154: return(ntok == n->tok ? REW_HALT : REW_NOHALT);
155: }
156:
157:
1.19 kristaps 158: /*
159: * There are three scope levels: scoped to the root (all), scoped to the
160: * section (all less sections), and scoped to subsections (all less
161: * sections and subsections).
162: */
1.34 kristaps 163: static enum rew
1.33 kristaps 164: rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
1.19 kristaps 165: {
1.34 kristaps 166: enum rew c;
1.1 kristaps 167:
1.38 kristaps 168: /* We cannot progress beyond the root ever. */
1.19 kristaps 169: if (MAN_ROOT == n->type)
170: return(REW_HALT);
1.38 kristaps 171:
1.19 kristaps 172: assert(n->parent);
1.38 kristaps 173:
174: /* Normal nodes shouldn't go to the level of the root. */
1.19 kristaps 175: if (MAN_ROOT == n->parent->type)
176: return(REW_REWIND);
1.38 kristaps 177:
178: /* Already-validated nodes should be closed out. */
1.19 kristaps 179: if (MAN_VALID & n->flags)
180: return(REW_NOHALT);
181:
1.38 kristaps 182: /* First: rewind to ourselves. */
1.21 kristaps 183: if (type == n->type && tok == n->tok)
184: return(REW_REWIND);
185:
1.38 kristaps 186: /*
187: * Next follow the implicit scope-smashings as defined by man.7:
188: * section, sub-section, etc.
189: */
190:
1.19 kristaps 191: switch (tok) {
192: case (MAN_SH):
193: break;
194: case (MAN_SS):
1.20 kristaps 195: /* Rewind to a section, if a block. */
1.21 kristaps 196: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
197: return(c);
198: break;
199: case (MAN_RS):
200: /* Rewind to a subsection, if a block. */
201: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
202: return(c);
203: /* Rewind to a section, if a block. */
204: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
205: return(c);
1.19 kristaps 206: break;
207: default:
1.21 kristaps 208: /* Rewind to an offsetter, if a block. */
209: if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
210: return(c);
1.20 kristaps 211: /* Rewind to a subsection, if a block. */
1.21 kristaps 212: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
213: return(c);
1.20 kristaps 214: /* Rewind to a section, if a block. */
1.21 kristaps 215: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
216: return(c);
1.19 kristaps 217: break;
1.3 kristaps 218: }
1.1 kristaps 219:
1.19 kristaps 220: return(REW_NOHALT);
221: }
1.9 kristaps 222:
223:
1.19 kristaps 224: /*
225: * Rewinding entails ascending the parse tree until a coherent point,
226: * for example, the `SH' macro will close out any intervening `SS'
227: * scopes. When a scope is closed, it must be validated and actioned.
228: */
229: static int
1.33 kristaps 230: rew_scope(enum man_type type, struct man *m, enum mant tok)
1.19 kristaps 231: {
232: struct man_node *n;
1.34 kristaps 233: enum rew c;
1.7 kristaps 234:
1.19 kristaps 235: /* LINTED */
236: for (n = m->last; n; n = n->parent) {
237: /*
238: * Whether we should stop immediately (REW_HALT), stop
239: * and rewind until this point (REW_REWIND), or keep
240: * rewinding (REW_NOHALT).
241: */
242: c = rew_dohalt(tok, type, n);
243: if (REW_HALT == c)
244: return(1);
245: if (REW_REWIND == c)
1.7 kristaps 246: break;
1.6 kristaps 247: }
1.1 kristaps 248:
1.38 kristaps 249: /*
250: * Rewind until the current point. Warn if we're a roff
251: * instruction that's mowing over explicit scopes.
252: */
253: assert(n);
1.19 kristaps 254:
1.46 kristaps 255: return(man_unscope(m, n, MANDOCERR_MAX));
1.19 kristaps 256: }
257:
1.6 kristaps 258:
1.36 kristaps 259: /*
260: * Close out a generic explicit macro.
261: */
1.37 kristaps 262: /* ARGSUSED */
1.35 kristaps 263: int
1.21 kristaps 264: blk_close(MACRO_PROT_ARGS)
265: {
1.33 kristaps 266: enum mant ntok;
1.21 kristaps 267: const struct man_node *nn;
268:
269: switch (tok) {
270: case (MAN_RE):
271: ntok = MAN_RS;
272: break;
273: default:
274: abort();
275: /* NOTREACHED */
276: }
277:
278: for (nn = m->last->parent; nn; nn = nn->parent)
279: if (ntok == nn->tok)
280: break;
281:
282: if (NULL == nn)
1.56 kristaps 283: man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
1.21 kristaps 284:
285: if ( ! rew_scope(MAN_BODY, m, ntok))
286: return(0);
287: if ( ! rew_scope(MAN_BLOCK, m, ntok))
288: return(0);
1.35 kristaps 289:
1.21 kristaps 290: return(1);
291: }
292:
293:
1.48 kristaps 294: /* ARGSUSED */
1.35 kristaps 295: int
296: blk_exp(MACRO_PROT_ARGS)
297: {
298: int w, la;
299: char *p;
300:
301: /*
302: * Close out prior scopes. "Regular" explicit macros cannot be
303: * nested, but we allow roff macros to be placed just about
304: * anywhere.
305: */
306:
1.44 kristaps 307: if ( ! rew_scope(MAN_BODY, m, tok))
308: return(0);
309: if ( ! rew_scope(MAN_BLOCK, m, tok))
310: return(0);
1.35 kristaps 311:
312: if ( ! man_block_alloc(m, line, ppos, tok))
313: return(0);
314: if ( ! man_head_alloc(m, line, ppos, tok))
315: return(0);
316:
317: for (;;) {
318: la = *pos;
319: w = man_args(m, line, pos, buf, &p);
320:
321: if (-1 == w)
322: return(0);
323: if (0 == w)
324: break;
325:
326: if ( ! man_word_alloc(m, line, la, p))
327: return(0);
328: }
329:
330: assert(m);
331: assert(tok != MAN_MAX);
332:
333: if ( ! rew_scope(MAN_HEAD, m, tok))
334: return(0);
335: return(man_body_alloc(m, line, ppos, tok));
336: }
337:
338:
339:
1.19 kristaps 340: /*
341: * Parse an implicit-block macro. These contain a MAN_HEAD and a
342: * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
343: * scopes, such as `SH' closing out an `SS', are defined in the rew
344: * routines.
345: */
1.48 kristaps 346: /* ARGSUSED */
1.19 kristaps 347: int
348: blk_imp(MACRO_PROT_ARGS)
349: {
350: int w, la;
351: char *p;
1.25 kristaps 352: struct man_node *n;
1.19 kristaps 353:
354: /* Close out prior scopes. */
1.7 kristaps 355:
1.19 kristaps 356: if ( ! rew_scope(MAN_BODY, m, tok))
1.5 kristaps 357: return(0);
1.19 kristaps 358: if ( ! rew_scope(MAN_BLOCK, m, tok))
1.6 kristaps 359: return(0);
1.1 kristaps 360:
1.19 kristaps 361: /* Allocate new block & head scope. */
362:
363: if ( ! man_block_alloc(m, line, ppos, tok))
364: return(0);
365: if ( ! man_head_alloc(m, line, ppos, tok))
366: return(0);
1.1 kristaps 367:
1.25 kristaps 368: n = m->last;
369:
1.19 kristaps 370: /* Add line arguments. */
1.3 kristaps 371:
1.19 kristaps 372: for (;;) {
373: la = *pos;
374: w = man_args(m, line, pos, buf, &p);
1.4 kristaps 375:
1.19 kristaps 376: if (-1 == w)
1.6 kristaps 377: return(0);
1.19 kristaps 378: if (0 == w)
379: break;
380:
381: if ( ! man_word_alloc(m, line, la, p))
1.6 kristaps 382: return(0);
383: }
384:
1.19 kristaps 385: /* Close out head and open body (unless MAN_SCOPE). */
386:
1.27 kristaps 387: if (MAN_SCOPED & man_macros[tok].flags) {
388: /* If we're forcing scope (`TP'), keep it open. */
389: if (MAN_FSCOPED & man_macros[tok].flags) {
390: m->flags |= MAN_BLINE;
391: return(1);
392: } else if (n == m->last) {
393: m->flags |= MAN_BLINE;
394: return(1);
395: }
396: }
397:
398: if ( ! rew_scope(MAN_HEAD, m, tok))
1.6 kristaps 399: return(0);
1.19 kristaps 400: return(man_body_alloc(m, line, ppos, tok));
1.4 kristaps 401: }
402:
403:
1.48 kristaps 404: /* ARGSUSED */
1.19 kristaps 405: int
406: in_line_eoln(MACRO_PROT_ARGS)
1.3 kristaps 407: {
1.19 kristaps 408: int w, la;
409: char *p;
410: struct man_node *n;
1.3 kristaps 411:
1.19 kristaps 412: if ( ! man_elem_alloc(m, line, ppos, tok))
1.3 kristaps 413: return(0);
414:
1.19 kristaps 415: n = m->last;
1.3 kristaps 416:
1.19 kristaps 417: for (;;) {
418: la = *pos;
419: w = man_args(m, line, pos, buf, &p);
1.3 kristaps 420:
1.19 kristaps 421: if (-1 == w)
422: return(0);
423: if (0 == w)
424: break;
425: if ( ! man_word_alloc(m, line, la, p))
426: return(0);
427: }
1.3 kristaps 428:
1.31 kristaps 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.25 kristaps 435: if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
1.31 kristaps 436: assert( ! (MAN_NSCOPED & man_macros[tok].flags));
1.19 kristaps 437: m->flags |= MAN_ELINE;
438: return(1);
439: }
1.3 kristaps 440:
1.31 kristaps 441: /* Set ignorable context, if applicable. */
442:
443: if (MAN_NSCOPED & man_macros[tok].flags) {
444: assert( ! (MAN_SCOPED & man_macros[tok].flags));
445: m->flags |= MAN_ILINE;
446: }
447:
1.19 kristaps 448: /*
1.31 kristaps 449: * Rewind our element scope. Note that when TH is pruned, we'll
450: * be back at the root, so make sure that we don't clobber as
451: * its sibling.
1.19 kristaps 452: */
1.3 kristaps 453:
1.19 kristaps 454: for ( ; m->last; m->last = m->last->parent) {
455: if (m->last == n)
456: break;
457: if (m->last->type == MAN_ROOT)
458: break;
459: if ( ! man_valid_post(m))
460: return(0);
461: }
1.3 kristaps 462:
1.19 kristaps 463: assert(m->last);
1.3 kristaps 464:
465: /*
1.19 kristaps 466: * Same here regarding whether we're back at the root.
1.3 kristaps 467: */
468:
1.19 kristaps 469: if (m->last->type != MAN_ROOT && ! man_valid_post(m))
470: return(0);
1.35 kristaps 471:
472: m->next = MAN_ROOT == m->last->type ?
473: MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
1.3 kristaps 474:
1.19 kristaps 475: return(1);
476: }
1.3 kristaps 477:
478:
1.19 kristaps 479: int
480: man_macroend(struct man *m)
481: {
1.22 kristaps 482:
1.46 kristaps 483: return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));
1.19 kristaps 484: }
1.3 kristaps 485:
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