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