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