Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.19
1.19 ! schwarze 1: /* $Id: man_macro.c,v 1.18 2010/05/23 20:57:16 schwarze Exp $ */
1.1 kristaps 2: /*
1.2 schwarze 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
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 */
1.6 schwarze 68: { in_line_eoln, 0 }, /* i */
1.11 schwarze 69: { in_line_eoln, MAN_NSCOPED }, /* sp */
1.6 schwarze 70: { in_line_eoln, 0 }, /* nf */
71: { in_line_eoln, 0 }, /* fi */
72: { in_line_eoln, 0 }, /* r */
1.7 schwarze 73: { blk_close, 0 }, /* RE */
1.12 schwarze 74: { blk_exp, MAN_EXPLICIT }, /* RS */
1.7 schwarze 75: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 76: { in_line_eoln, 0 }, /* UC */
1.9 schwarze 77: { in_line_eoln, 0 }, /* PD */
1.12 schwarze 78: { in_line_eoln, MAN_NSCOPED }, /* Sp */
1.10 schwarze 79: { in_line_eoln, 0 }, /* Vb */
80: { in_line_eoln, 0 }, /* Ve */
1.18 schwarze 81: { in_line_eoln, 0 }, /* AT */
1.6 schwarze 82: };
1.1 kristaps 83:
1.6 schwarze 84: const struct man_macro * const man_macros = __man_macros;
1.1 kristaps 85:
86:
1.13 schwarze 87: /*
88: * Warn when "n" is an explicit non-roff macro.
89: */
90: static int
1.19 ! schwarze 91: rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
1.13 schwarze 92: {
93:
1.19 ! schwarze 94: if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
1.13 schwarze 95: return(1);
96: if (MAN_VALID & n->flags)
97: return(1);
98: if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
99: return(1);
1.19 ! schwarze 100: return(man_nmsg(m, n, er));
1.13 schwarze 101: }
102:
103:
104: /*
1.19 ! schwarze 105: * Rewind scope. If a code "er" != MANDOCERR_MAX has been provided, it
! 106: * will be used if an explicit block scope is being closed out.
1.13 schwarze 107: */
1.1 kristaps 108: int
1.19 ! schwarze 109: man_unscope(struct man *m, const struct man_node *n,
! 110: enum mandocerr er)
1.1 kristaps 111: {
112:
1.6 schwarze 113: assert(n);
114:
115: /* LINTED */
116: while (m->last != n) {
1.13 schwarze 117: if ( ! rew_warn(m, m->last, er))
118: return(0);
1.6 schwarze 119: if ( ! man_valid_post(m))
120: return(0);
121: if ( ! man_action_post(m))
122: return(0);
123: m->last = m->last->parent;
124: assert(m->last);
125: }
126:
1.13 schwarze 127: if ( ! rew_warn(m, m->last, er))
128: return(0);
1.6 schwarze 129: if ( ! man_valid_post(m))
1.1 kristaps 130: return(0);
1.12 schwarze 131: if ( ! man_action_post(m))
132: return(0);
133:
134: m->next = MAN_ROOT == m->last->type ?
135: MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
136:
137: return(1);
1.6 schwarze 138: }
1.1 kristaps 139:
140:
1.12 schwarze 141: static enum rew
142: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.7 schwarze 143: {
144:
145: if (MAN_BLOCK == type && ntok == n->parent->tok &&
146: MAN_BODY == n->parent->type)
147: return(REW_REWIND);
148: return(ntok == n->tok ? REW_HALT : REW_NOHALT);
149: }
150:
151:
1.6 schwarze 152: /*
153: * There are three scope levels: scoped to the root (all), scoped to the
154: * section (all less sections), and scoped to subsections (all less
155: * sections and subsections).
156: */
1.12 schwarze 157: static enum rew
158: rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
1.6 schwarze 159: {
1.12 schwarze 160: enum rew c;
1.1 kristaps 161:
1.13 schwarze 162: /* We cannot progress beyond the root ever. */
1.6 schwarze 163: if (MAN_ROOT == n->type)
164: return(REW_HALT);
1.13 schwarze 165:
1.6 schwarze 166: assert(n->parent);
1.13 schwarze 167:
168: /* Normal nodes shouldn't go to the level of the root. */
1.6 schwarze 169: if (MAN_ROOT == n->parent->type)
170: return(REW_REWIND);
1.13 schwarze 171:
172: /* Already-validated nodes should be closed out. */
1.6 schwarze 173: if (MAN_VALID & n->flags)
174: return(REW_NOHALT);
175:
1.13 schwarze 176: /* First: rewind to ourselves. */
1.7 schwarze 177: if (type == n->type && tok == n->tok)
178: return(REW_REWIND);
179:
1.13 schwarze 180: /*
181: * Next follow the implicit scope-smashings as defined by man.7:
182: * section, sub-section, etc.
183: */
184:
1.6 schwarze 185: switch (tok) {
186: case (MAN_SH):
187: break;
188: case (MAN_SS):
189: /* Rewind to a section, if a block. */
1.7 schwarze 190: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
191: return(c);
192: break;
193: case (MAN_RS):
194: /* Rewind to a subsection, if a block. */
195: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
196: return(c);
197: /* Rewind to a section, if a block. */
198: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
199: return(c);
1.6 schwarze 200: break;
201: default:
1.7 schwarze 202: /* Rewind to an offsetter, if a block. */
203: if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
204: return(c);
1.6 schwarze 205: /* Rewind to a subsection, if a block. */
1.7 schwarze 206: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
207: return(c);
1.6 schwarze 208: /* Rewind to a section, if a block. */
1.7 schwarze 209: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
210: return(c);
1.6 schwarze 211: break;
1.1 kristaps 212: }
213:
1.6 schwarze 214: return(REW_NOHALT);
215: }
1.1 kristaps 216:
217:
1.6 schwarze 218: /*
219: * Rewinding entails ascending the parse tree until a coherent point,
220: * for example, the `SH' macro will close out any intervening `SS'
221: * scopes. When a scope is closed, it must be validated and actioned.
222: */
223: static int
1.12 schwarze 224: rew_scope(enum man_type type, struct man *m, enum mant tok)
1.6 schwarze 225: {
226: struct man_node *n;
1.12 schwarze 227: enum rew c;
1.1 kristaps 228:
1.6 schwarze 229: /* LINTED */
230: for (n = m->last; n; n = n->parent) {
231: /*
232: * Whether we should stop immediately (REW_HALT), stop
233: * and rewind until this point (REW_REWIND), or keep
234: * rewinding (REW_NOHALT).
235: */
236: c = rew_dohalt(tok, type, n);
237: if (REW_HALT == c)
238: return(1);
239: if (REW_REWIND == c)
1.1 kristaps 240: break;
241: }
242:
1.13 schwarze 243: /*
244: * Rewind until the current point. Warn if we're a roff
245: * instruction that's mowing over explicit scopes.
246: */
247: assert(n);
1.6 schwarze 248:
1.19 ! schwarze 249: return(man_unscope(m, n, MANDOCERR_MAX));
1.6 schwarze 250: }
251:
1.1 kristaps 252:
1.12 schwarze 253: /*
254: * Close out a generic explicit macro.
255: */
1.7 schwarze 256: /* ARGSUSED */
257: int
258: blk_close(MACRO_PROT_ARGS)
259: {
1.12 schwarze 260: enum mant ntok;
1.7 schwarze 261: const struct man_node *nn;
262:
263: switch (tok) {
264: case (MAN_RE):
265: ntok = MAN_RS;
266: break;
267: default:
268: abort();
269: /* NOTREACHED */
270: }
271:
272: for (nn = m->last->parent; nn; nn = nn->parent)
273: if (ntok == nn->tok)
274: break;
275:
276: if (NULL == nn)
1.19 ! schwarze 277: if ( ! man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE))
1.7 schwarze 278: return(0);
279:
280: if ( ! rew_scope(MAN_BODY, m, ntok))
281: return(0);
282: if ( ! rew_scope(MAN_BLOCK, m, ntok))
283: return(0);
1.12 schwarze 284:
1.7 schwarze 285: return(1);
286: }
287:
288:
1.12 schwarze 289: int
290: blk_exp(MACRO_PROT_ARGS)
291: {
292: int w, la;
293: char *p;
294:
295: /*
296: * Close out prior scopes. "Regular" explicit macros cannot be
297: * nested, but we allow roff macros to be placed just about
298: * anywhere.
299: */
300:
1.16 schwarze 301: if ( ! rew_scope(MAN_BODY, m, tok))
302: return(0);
303: if ( ! rew_scope(MAN_BLOCK, m, tok))
304: return(0);
1.12 schwarze 305:
306: if ( ! man_block_alloc(m, line, ppos, tok))
307: return(0);
308: if ( ! man_head_alloc(m, line, ppos, tok))
309: return(0);
310:
311: for (;;) {
312: la = *pos;
313: w = man_args(m, line, pos, buf, &p);
314:
315: if (-1 == w)
316: return(0);
317: if (0 == w)
318: break;
319:
320: if ( ! man_word_alloc(m, line, la, p))
321: return(0);
322: }
323:
324: assert(m);
325: assert(tok != MAN_MAX);
326:
327: if ( ! rew_scope(MAN_HEAD, m, tok))
328: return(0);
329: return(man_body_alloc(m, line, ppos, tok));
330: }
331:
332:
333:
1.6 schwarze 334: /*
335: * Parse an implicit-block macro. These contain a MAN_HEAD and a
336: * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
337: * scopes, such as `SH' closing out an `SS', are defined in the rew
338: * routines.
339: */
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.6 schwarze 397: int
398: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 399: {
1.6 schwarze 400: int w, la;
401: char *p;
402: struct man_node *n;
1.1 kristaps 403:
1.6 schwarze 404: if ( ! man_elem_alloc(m, line, ppos, tok))
1.1 kristaps 405: return(0);
406:
1.6 schwarze 407: n = m->last;
1.1 kristaps 408:
1.6 schwarze 409: for (;;) {
410: la = *pos;
411: w = man_args(m, line, pos, buf, &p);
1.1 kristaps 412:
1.6 schwarze 413: if (-1 == w)
414: return(0);
415: if (0 == w)
416: break;
417: if ( ! man_word_alloc(m, line, la, p))
418: return(0);
419: }
1.1 kristaps 420:
1.11 schwarze 421: /*
422: * If no arguments are specified and this is MAN_SCOPED (i.e.,
423: * next-line scoped), then set our mode to indicate that we're
424: * waiting for terms to load into our context.
425: */
426:
1.7 schwarze 427: if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
1.11 schwarze 428: assert( ! (MAN_NSCOPED & man_macros[tok].flags));
1.6 schwarze 429: m->flags |= MAN_ELINE;
430: return(1);
431: }
1.1 kristaps 432:
1.11 schwarze 433: /* Set ignorable context, if applicable. */
434:
435: if (MAN_NSCOPED & man_macros[tok].flags) {
436: assert( ! (MAN_SCOPED & man_macros[tok].flags));
437: m->flags |= MAN_ILINE;
438: }
439:
1.6 schwarze 440: /*
1.11 schwarze 441: * Rewind our element scope. Note that when TH is pruned, we'll
442: * be back at the root, so make sure that we don't clobber as
443: * its sibling.
1.6 schwarze 444: */
1.1 kristaps 445:
1.6 schwarze 446: for ( ; m->last; m->last = m->last->parent) {
447: if (m->last == n)
448: break;
449: if (m->last->type == MAN_ROOT)
450: break;
451: if ( ! man_valid_post(m))
452: return(0);
453: if ( ! man_action_post(m))
454: return(0);
455: }
1.1 kristaps 456:
1.6 schwarze 457: assert(m->last);
1.1 kristaps 458:
459: /*
1.6 schwarze 460: * Same here regarding whether we're back at the root.
1.1 kristaps 461: */
462:
1.6 schwarze 463: if (m->last->type != MAN_ROOT && ! man_valid_post(m))
464: return(0);
465: if (m->last->type != MAN_ROOT && ! man_action_post(m))
466: return(0);
1.12 schwarze 467:
468: m->next = MAN_ROOT == m->last->type ?
469: MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
1.1 kristaps 470:
1.6 schwarze 471: return(1);
472: }
1.1 kristaps 473:
474:
1.6 schwarze 475: int
476: man_macroend(struct man *m)
477: {
1.1 kristaps 478:
1.19 ! schwarze 479: return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));
1.6 schwarze 480: }
1.1 kristaps 481:
![[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