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