1 /* $Id: man_macro.c,v 1.42 2010/03/29 10:10:35 kristaps Exp $ */
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
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.
30 static int blk_close(MACRO_PROT_ARGS);
31 static int blk_dotted(MACRO_PROT_ARGS);
32 static int blk_exp(MACRO_PROT_ARGS);
33 static int blk_imp(MACRO_PROT_ARGS);
34 static int in_line_eoln(MACRO_PROT_ARGS);
36 static int rew_scope(enum man_type,
37 struct man *, enum mant);
38 static enum rew rew_dohalt(enum mant, enum man_type,
39 const struct man_node *);
40 static enum rew rew_block(enum mant, enum man_type,
41 const struct man_node *);
42 static int rew_warn(struct man *,
43 struct man_node *, enum merr);
45 const struct man_macro __man_macros[MAN_MAX] = {
46 { in_line_eoln, MAN_NSCOPED }, /* br */
47 { in_line_eoln, 0 }, /* TH */
48 { blk_imp, MAN_SCOPED }, /* SH */
49 { blk_imp, MAN_SCOPED }, /* SS */
50 { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */
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 */
67 { in_line_eoln, MAN_NSCOPED }, /* na */
68 { in_line_eoln, 0 }, /* i */
69 { in_line_eoln, MAN_NSCOPED }, /* sp */
70 { in_line_eoln, 0 }, /* nf */
71 { in_line_eoln, 0 }, /* fi */
72 { in_line_eoln, 0 }, /* r */
73 { blk_close, 0 }, /* RE */
74 { blk_exp, MAN_EXPLICIT }, /* RS */
75 { in_line_eoln, 0 }, /* DT */
76 { in_line_eoln, 0 }, /* UC */
77 { in_line_eoln, 0 }, /* PD */
78 { in_line_eoln, MAN_NSCOPED }, /* Sp */
79 { in_line_eoln, 0 }, /* Vb */
80 { in_line_eoln, 0 }, /* Ve */
81 { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* de */
82 { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* dei */
83 { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* am */
84 { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ami */
85 { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ig */
86 { blk_dotted, 0 }, /* . */
89 const struct man_macro * const man_macros = __man_macros;
93 * Warn when "n" is an explicit non-roff macro.
96 rew_warn(struct man *m, struct man_node *n, enum merr er)
99 if (er == WERRMAX || MAN_BLOCK != n->type)
101 if (MAN_VALID & n->flags)
103 if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
105 if (MAN_NOCLOSE & man_macros[n->tok].flags)
107 return(man_nwarn(m, n, er));
112 * Rewind scope. If a code "er" != WERRMAX has been provided, it will
113 * be used if an explicit block scope is being closed out.
116 man_unscope(struct man *m, const struct man_node *n, enum merr er)
122 while (m->last != n) {
123 if ( ! rew_warn(m, m->last, er))
125 if ( ! man_valid_post(m))
127 if ( ! man_action_post(m))
129 m->last = m->last->parent;
133 if ( ! rew_warn(m, m->last, er))
135 if ( ! man_valid_post(m))
137 if ( ! man_action_post(m))
140 m->next = MAN_ROOT == m->last->type ?
141 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
148 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
151 if (MAN_BLOCK == type && ntok == n->parent->tok &&
152 MAN_BODY == n->parent->type)
154 return(ntok == n->tok ? REW_HALT : REW_NOHALT);
159 * There are three scope levels: scoped to the root (all), scoped to the
160 * section (all less sections), and scoped to subsections (all less
161 * sections and subsections).
164 rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
168 /* We cannot progress beyond the root ever. */
169 if (MAN_ROOT == n->type)
174 /* Normal nodes shouldn't go to the level of the root. */
175 if (MAN_ROOT == n->parent->type)
178 /* Already-validated nodes should be closed out. */
179 if (MAN_VALID & n->flags)
182 /* First: rewind to ourselves. */
183 if (type == n->type && tok == n->tok)
187 * If we're a roff macro, then we can close out anything that
188 * stands between us and our parent context.
190 if (MAN_NOCLOSE & man_macros[tok].flags)
194 * Don't clobber roff macros: this is a bit complicated. If the
195 * current macro is a roff macro, halt immediately and don't
196 * rewind. If it's not, and the parent is, then close out the
197 * current scope and halt at the parent.
199 if (MAN_NOCLOSE & man_macros[n->tok].flags)
201 if (MAN_NOCLOSE & man_macros[n->parent->tok].flags)
205 * Next follow the implicit scope-smashings as defined by man.7:
206 * section, sub-section, etc.
213 /* Rewind to a section, if a block. */
214 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
218 /* Rewind to a subsection, if a block. */
219 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
221 /* Rewind to a section, if a block. */
222 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
226 /* Rewind to an offsetter, if a block. */
227 if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
229 /* Rewind to a subsection, if a block. */
230 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
232 /* Rewind to a section, if a block. */
233 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
243 * Rewinding entails ascending the parse tree until a coherent point,
244 * for example, the `SH' macro will close out any intervening `SS'
245 * scopes. When a scope is closed, it must be validated and actioned.
248 rew_scope(enum man_type type, struct man *m, enum mant tok)
254 for (n = m->last; n; n = n->parent) {
256 * Whether we should stop immediately (REW_HALT), stop
257 * and rewind until this point (REW_REWIND), or keep
258 * rewinding (REW_NOHALT).
260 c = rew_dohalt(tok, type, n);
268 * Rewind until the current point. Warn if we're a roff
269 * instruction that's mowing over explicit scopes.
272 if (MAN_NOCLOSE & man_macros[tok].flags)
273 return(man_unscope(m, n, WROFFSCOPE));
275 return(man_unscope(m, n, WERRMAX));
280 * Closure for dotted macros (de, dei, am, ami, ign). This must handle
281 * any of these as the parent node, so it needs special handling.
282 * Beyond this, it's the same as blk_close().
286 blk_dotted(MACRO_PROT_ARGS)
291 /* Check for any of the following parents... */
293 for (nn = m->last->parent; nn; nn = nn->parent)
294 if (nn->tok == MAN_de || nn->tok == MAN_dei ||
296 nn->tok == MAN_ami ||
303 if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
308 if ( ! rew_scope(MAN_BODY, m, ntok))
310 if ( ! rew_scope(MAN_BLOCK, m, ntok))
314 * Restore flags set when we got here and also stipulate that we
315 * don't post-process the line when exiting the macro op
316 * function in man_pmacro(). See blk_exp().
319 m->flags = m->svflags | MAN_ILINE;
326 * Close out a generic explicit macro.
330 blk_close(MACRO_PROT_ARGS)
333 const struct man_node *nn;
344 for (nn = m->last->parent; nn; nn = nn->parent)
349 if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
352 if ( ! rew_scope(MAN_BODY, m, ntok))
354 if ( ! rew_scope(MAN_BLOCK, m, ntok))
362 blk_exp(MACRO_PROT_ARGS)
368 * Close out prior scopes. "Regular" explicit macros cannot be
369 * nested, but we allow roff macros to be placed just about
373 if ( ! (MAN_NOCLOSE & man_macros[tok].flags)) {
374 if ( ! rew_scope(MAN_BODY, m, tok))
376 if ( ! rew_scope(MAN_BLOCK, m, tok))
380 * Save our state and next-scope indicator; we restore
381 * it when exiting from the roff instruction block. See
384 m->svflags = m->flags;
387 /* Make sure we drop any line modes. */
391 if ( ! man_block_alloc(m, line, ppos, tok))
393 if ( ! man_head_alloc(m, line, ppos, tok))
398 w = man_args(m, line, pos, buf, &p);
405 if ( ! man_word_alloc(m, line, la, p))
410 assert(tok != MAN_MAX);
412 if ( ! rew_scope(MAN_HEAD, m, tok))
414 return(man_body_alloc(m, line, ppos, tok));
420 * Parse an implicit-block macro. These contain a MAN_HEAD and a
421 * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
422 * scopes, such as `SH' closing out an `SS', are defined in the rew
426 blk_imp(MACRO_PROT_ARGS)
432 /* Close out prior scopes. */
434 if ( ! rew_scope(MAN_BODY, m, tok))
436 if ( ! rew_scope(MAN_BLOCK, m, tok))
439 /* Allocate new block & head scope. */
441 if ( ! man_block_alloc(m, line, ppos, tok))
443 if ( ! man_head_alloc(m, line, ppos, tok))
448 /* Add line arguments. */
452 w = man_args(m, line, pos, buf, &p);
459 if ( ! man_word_alloc(m, line, la, p))
463 /* Close out head and open body (unless MAN_SCOPE). */
465 if (MAN_SCOPED & man_macros[tok].flags) {
466 /* If we're forcing scope (`TP'), keep it open. */
467 if (MAN_FSCOPED & man_macros[tok].flags) {
468 m->flags |= MAN_BLINE;
470 } else if (n == m->last) {
471 m->flags |= MAN_BLINE;
476 if ( ! rew_scope(MAN_HEAD, m, tok))
478 return(man_body_alloc(m, line, ppos, tok));
483 in_line_eoln(MACRO_PROT_ARGS)
489 if ( ! man_elem_alloc(m, line, ppos, tok))
496 w = man_args(m, line, pos, buf, &p);
502 if ( ! man_word_alloc(m, line, la, p))
507 * If no arguments are specified and this is MAN_SCOPED (i.e.,
508 * next-line scoped), then set our mode to indicate that we're
509 * waiting for terms to load into our context.
512 if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
513 assert( ! (MAN_NSCOPED & man_macros[tok].flags));
514 m->flags |= MAN_ELINE;
518 /* Set ignorable context, if applicable. */
520 if (MAN_NSCOPED & man_macros[tok].flags) {
521 assert( ! (MAN_SCOPED & man_macros[tok].flags));
522 m->flags |= MAN_ILINE;
526 * Rewind our element scope. Note that when TH is pruned, we'll
527 * be back at the root, so make sure that we don't clobber as
531 for ( ; m->last; m->last = m->last->parent) {
534 if (m->last->type == MAN_ROOT)
536 if ( ! man_valid_post(m))
538 if ( ! man_action_post(m))
545 * Same here regarding whether we're back at the root.
548 if (m->last->type != MAN_ROOT && ! man_valid_post(m))
550 if (m->last->type != MAN_ROOT && ! man_action_post(m))
553 m->next = MAN_ROOT == m->last->type ?
554 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
561 man_macroend(struct man *m)
564 return(man_unscope(m, m->first, WEXITSCOPE));