1 /* $Id: man_macro.c,v 1.54 2010/12/08 10:58:22 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
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.
35 static int blk_close(MACRO_PROT_ARGS);
36 static int blk_exp(MACRO_PROT_ARGS);
37 static int blk_imp(MACRO_PROT_ARGS);
38 static int in_line_eoln(MACRO_PROT_ARGS);
40 static int rew_scope(enum man_type,
41 struct man *, enum mant);
42 static enum rew rew_dohalt(enum mant, enum man_type,
43 const struct man_node *);
44 static enum rew rew_block(enum mant, enum man_type,
45 const struct man_node *);
46 static int rew_warn(struct man *,
47 struct man_node *, enum mandocerr);
49 const struct man_macro __man_macros[MAN_MAX] = {
50 { in_line_eoln, MAN_NSCOPED }, /* br */
51 { in_line_eoln, 0 }, /* TH */
52 { blk_imp, MAN_SCOPED }, /* SH */
53 { blk_imp, MAN_SCOPED }, /* SS */
54 { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */
55 { blk_imp, 0 }, /* LP */
56 { blk_imp, 0 }, /* PP */
57 { blk_imp, 0 }, /* P */
58 { blk_imp, 0 }, /* IP */
59 { blk_imp, 0 }, /* HP */
60 { in_line_eoln, MAN_SCOPED }, /* SM */
61 { in_line_eoln, MAN_SCOPED }, /* SB */
62 { in_line_eoln, 0 }, /* BI */
63 { in_line_eoln, 0 }, /* IB */
64 { in_line_eoln, 0 }, /* BR */
65 { in_line_eoln, 0 }, /* RB */
66 { in_line_eoln, MAN_SCOPED }, /* R */
67 { in_line_eoln, MAN_SCOPED }, /* B */
68 { in_line_eoln, MAN_SCOPED }, /* I */
69 { in_line_eoln, 0 }, /* IR */
70 { in_line_eoln, 0 }, /* RI */
71 { in_line_eoln, MAN_NSCOPED }, /* na */
72 { in_line_eoln, MAN_NSCOPED }, /* sp */
73 { in_line_eoln, 0 }, /* nf */
74 { in_line_eoln, 0 }, /* fi */
75 { blk_close, 0 }, /* RE */
76 { blk_exp, MAN_EXPLICIT }, /* RS */
77 { in_line_eoln, 0 }, /* DT */
78 { in_line_eoln, 0 }, /* UC */
79 { in_line_eoln, 0 }, /* PD */
80 { in_line_eoln, 0 }, /* AT */
81 { in_line_eoln, 0 }, /* in */
82 { in_line_eoln, 0 }, /* ft */
85 const struct man_macro * const man_macros = __man_macros;
89 * Warn when "n" is an explicit non-roff macro.
92 rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
95 if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
97 if (MAN_VALID & n->flags)
99 if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
101 return(man_nmsg(m, n, er));
106 * Rewind scope. If a code "er" != MANDOCERR_MAX has been provided, it
107 * will be used if an explicit block scope is being closed out.
110 man_unscope(struct man *m, const struct man_node *n,
117 while (m->last != n) {
118 if ( ! rew_warn(m, m->last, er))
120 if ( ! man_valid_post(m))
122 m->last = m->last->parent;
126 if ( ! rew_warn(m, m->last, er))
128 if ( ! man_valid_post(m))
131 m->next = MAN_ROOT == m->last->type ?
132 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
139 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
142 if (MAN_BLOCK == type && ntok == n->parent->tok &&
143 MAN_BODY == n->parent->type)
145 return(ntok == n->tok ? REW_HALT : REW_NOHALT);
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).
155 rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
159 /* We cannot progress beyond the root ever. */
160 if (MAN_ROOT == n->type)
165 /* Normal nodes shouldn't go to the level of the root. */
166 if (MAN_ROOT == n->parent->type)
169 /* Already-validated nodes should be closed out. */
170 if (MAN_VALID & n->flags)
173 /* First: rewind to ourselves. */
174 if (type == n->type && tok == n->tok)
178 * Next follow the implicit scope-smashings as defined by man.7:
179 * section, sub-section, etc.
186 /* Rewind to a section, if a block. */
187 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
191 /* Rewind to a subsection, if a block. */
192 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
194 /* Rewind to a section, if a block. */
195 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
199 /* Rewind to an offsetter, if a block. */
200 if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
202 /* Rewind to a subsection, if a block. */
203 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
205 /* Rewind to a section, if a block. */
206 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
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.
221 rew_scope(enum man_type type, struct man *m, enum mant tok)
227 for (n = m->last; n; n = n->parent) {
229 * Whether we should stop immediately (REW_HALT), stop
230 * and rewind until this point (REW_REWIND), or keep
231 * rewinding (REW_NOHALT).
233 c = rew_dohalt(tok, type, n);
241 * Rewind until the current point. Warn if we're a roff
242 * instruction that's mowing over explicit scopes.
246 return(man_unscope(m, n, MANDOCERR_MAX));
251 * Close out a generic explicit macro.
255 blk_close(MACRO_PROT_ARGS)
258 const struct man_node *nn;
269 for (nn = m->last->parent; nn; nn = nn->parent)
274 if ( ! man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE))
277 if ( ! rew_scope(MAN_BODY, m, ntok))
279 if ( ! rew_scope(MAN_BLOCK, m, ntok))
288 blk_exp(MACRO_PROT_ARGS)
294 * Close out prior scopes. "Regular" explicit macros cannot be
295 * nested, but we allow roff macros to be placed just about
299 if ( ! rew_scope(MAN_BODY, m, tok))
301 if ( ! rew_scope(MAN_BLOCK, m, tok))
304 if ( ! man_block_alloc(m, line, ppos, tok))
306 if ( ! man_head_alloc(m, line, ppos, tok))
311 w = man_args(m, line, pos, buf, &p);
318 if ( ! man_word_alloc(m, line, la, p))
323 assert(tok != MAN_MAX);
325 if ( ! rew_scope(MAN_HEAD, m, tok))
327 return(man_body_alloc(m, line, ppos, tok));
333 * Parse an implicit-block macro. These contain a MAN_HEAD and a
334 * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
335 * scopes, such as `SH' closing out an `SS', are defined in the rew
340 blk_imp(MACRO_PROT_ARGS)
346 /* Close out prior scopes. */
348 if ( ! rew_scope(MAN_BODY, m, tok))
350 if ( ! rew_scope(MAN_BLOCK, m, tok))
353 /* Allocate new block & head scope. */
355 if ( ! man_block_alloc(m, line, ppos, tok))
357 if ( ! man_head_alloc(m, line, ppos, tok))
362 /* Add line arguments. */
366 w = man_args(m, line, pos, buf, &p);
373 if ( ! man_word_alloc(m, line, la, p))
377 /* Close out head and open body (unless MAN_SCOPE). */
379 if (MAN_SCOPED & man_macros[tok].flags) {
380 /* If we're forcing scope (`TP'), keep it open. */
381 if (MAN_FSCOPED & man_macros[tok].flags) {
382 m->flags |= MAN_BLINE;
384 } else if (n == m->last) {
385 m->flags |= MAN_BLINE;
390 if ( ! rew_scope(MAN_HEAD, m, tok))
392 return(man_body_alloc(m, line, ppos, tok));
398 in_line_eoln(MACRO_PROT_ARGS)
404 if ( ! man_elem_alloc(m, line, ppos, tok))
411 w = man_args(m, line, pos, buf, &p);
417 if ( ! man_word_alloc(m, line, la, p))
422 * If no arguments are specified and this is MAN_SCOPED (i.e.,
423 * next-line scoped), then set our mode to indicate that we're
424 * waiting for terms to load into our context.
427 if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
428 assert( ! (MAN_NSCOPED & man_macros[tok].flags));
429 m->flags |= MAN_ELINE;
433 /* Set ignorable context, if applicable. */
435 if (MAN_NSCOPED & man_macros[tok].flags) {
436 assert( ! (MAN_SCOPED & man_macros[tok].flags));
437 m->flags |= MAN_ILINE;
441 * Rewind our element scope. Note that when TH is pruned, we'll
442 * be back at the root, so make sure that we don't clobber as
446 for ( ; m->last; m->last = m->last->parent) {
449 if (m->last->type == MAN_ROOT)
451 if ( ! man_valid_post(m))
458 * Same here regarding whether we're back at the root.
461 if (m->last->type != MAN_ROOT && ! man_valid_post(m))
464 m->next = MAN_ROOT == m->last->type ?
465 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
472 man_macroend(struct man *m)
475 return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));