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