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