1 /* $Id: man_macro.c,v 1.29 2009/10/24 05:45:05 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.
24 #define REW_REWIND (0) /* See rew_scope(). */
25 #define REW_NOHALT (1) /* See rew_scope(). */
26 #define REW_HALT (2) /* See rew_scope(). */
28 static int in_line_eoln(MACRO_PROT_ARGS);
29 static int blk_imp(MACRO_PROT_ARGS);
30 static int blk_close(MACRO_PROT_ARGS);
32 static int rew_scope(enum man_type, struct man *, int);
33 static int rew_dohalt(int, enum man_type,
34 const struct man_node *);
35 static int rew_block(int, enum man_type,
36 const struct man_node *);
38 const struct man_macro __man_macros[MAN_MAX] = {
39 { in_line_eoln, 0 }, /* br */
40 { in_line_eoln, 0 }, /* TH */
41 { blk_imp, MAN_SCOPED }, /* SH */
42 { blk_imp, MAN_SCOPED }, /* SS */
43 { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */
44 { blk_imp, 0 }, /* LP */
45 { blk_imp, 0 }, /* PP */
46 { blk_imp, 0 }, /* P */
47 { blk_imp, 0 }, /* IP */
48 { blk_imp, 0 }, /* HP */
49 { in_line_eoln, MAN_SCOPED }, /* SM */
50 { in_line_eoln, MAN_SCOPED }, /* SB */
51 { in_line_eoln, 0 }, /* BI */
52 { in_line_eoln, 0 }, /* IB */
53 { in_line_eoln, 0 }, /* BR */
54 { in_line_eoln, 0 }, /* RB */
55 { in_line_eoln, MAN_SCOPED }, /* R */
56 { in_line_eoln, MAN_SCOPED }, /* B */
57 { in_line_eoln, MAN_SCOPED }, /* I */
58 { in_line_eoln, 0 }, /* IR */
59 { in_line_eoln, 0 }, /* RI */
60 { in_line_eoln, 0 }, /* na */
61 { in_line_eoln, 0 }, /* i */
62 { in_line_eoln, 0 }, /* sp */
63 { in_line_eoln, 0 }, /* nf */
64 { in_line_eoln, 0 }, /* fi */
65 { in_line_eoln, 0 }, /* r */
66 { blk_close, 0 }, /* RE */
67 { blk_imp, MAN_EXPLICIT }, /* RS */
68 { in_line_eoln, 0 }, /* DT */
69 { in_line_eoln, 0 }, /* UC */
70 { in_line_eoln, 0 }, /* PD */
73 const struct man_macro * const man_macros = __man_macros;
77 man_unscope(struct man *m, const struct man_node *n)
81 m->next = MAN_NEXT_SIBLING;
84 while (m->last != n) {
85 if ( ! man_valid_post(m))
87 if ( ! man_action_post(m))
89 m->last = m->last->parent;
93 if ( ! man_valid_post(m))
95 return(man_action_post(m));
100 rew_block(int ntok, enum man_type type, const struct man_node *n)
103 if (MAN_BLOCK == type && ntok == n->parent->tok &&
104 MAN_BODY == n->parent->type)
106 return(ntok == n->tok ? REW_HALT : REW_NOHALT);
111 * There are three scope levels: scoped to the root (all), scoped to the
112 * section (all less sections), and scoped to subsections (all less
113 * sections and subsections).
116 rew_dohalt(int tok, enum man_type type, const struct man_node *n)
120 if (MAN_ROOT == n->type)
123 if (MAN_ROOT == n->parent->type)
125 if (MAN_VALID & n->flags)
128 /* Rewind to ourselves, first. */
129 if (type == n->type && tok == n->tok)
136 /* Rewind to a section, if a block. */
137 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
141 /* Rewind to a subsection, if a block. */
142 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
144 /* Rewind to a section, if a block. */
145 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
149 /* Rewind to an offsetter, if a block. */
150 if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
152 /* Rewind to a subsection, if a block. */
153 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
155 /* Rewind to a section, if a block. */
156 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
166 * Rewinding entails ascending the parse tree until a coherent point,
167 * for example, the `SH' macro will close out any intervening `SS'
168 * scopes. When a scope is closed, it must be validated and actioned.
171 rew_scope(enum man_type type, struct man *m, int tok)
177 for (n = m->last; n; n = n->parent) {
179 * Whether we should stop immediately (REW_HALT), stop
180 * and rewind until this point (REW_REWIND), or keep
181 * rewinding (REW_NOHALT).
183 c = rew_dohalt(tok, type, n);
190 /* Rewind until the current point. */
193 return(man_unscope(m, n));
199 blk_close(MACRO_PROT_ARGS)
202 const struct man_node *nn;
213 for (nn = m->last->parent; nn; nn = nn->parent)
218 if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
221 if ( ! rew_scope(MAN_BODY, m, ntok))
223 if ( ! rew_scope(MAN_BLOCK, m, ntok))
225 m->next = MAN_NEXT_SIBLING;
231 * Parse an implicit-block macro. These contain a MAN_HEAD and a
232 * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
233 * scopes, such as `SH' closing out an `SS', are defined in the rew
237 blk_imp(MACRO_PROT_ARGS)
243 /* Close out prior scopes. */
245 if ( ! rew_scope(MAN_BODY, m, tok))
247 if ( ! rew_scope(MAN_BLOCK, m, tok))
250 /* Allocate new block & head scope. */
252 if ( ! man_block_alloc(m, line, ppos, tok))
254 if ( ! man_head_alloc(m, line, ppos, tok))
259 /* Add line arguments. */
263 w = man_args(m, line, pos, buf, &p);
270 if ( ! man_word_alloc(m, line, la, p))
274 /* Close out head and open body (unless MAN_SCOPE). */
276 if (MAN_SCOPED & man_macros[tok].flags) {
277 /* If we're forcing scope (`TP'), keep it open. */
278 if (MAN_FSCOPED & man_macros[tok].flags) {
279 m->flags |= MAN_BLINE;
281 } else if (n == m->last) {
282 m->flags |= MAN_BLINE;
287 if ( ! rew_scope(MAN_HEAD, m, tok))
290 return(man_body_alloc(m, line, ppos, tok));
295 in_line_eoln(MACRO_PROT_ARGS)
301 if ( ! man_elem_alloc(m, line, ppos, tok))
308 w = man_args(m, line, pos, buf, &p);
315 if ( ! man_word_alloc(m, line, la, p))
319 if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
320 m->flags |= MAN_ELINE;
325 * Note that when TH is pruned, we'll be back at the root, so
326 * make sure that we don't clobber as its sibling.
329 for ( ; m->last; m->last = m->last->parent) {
332 if (m->last->type == MAN_ROOT)
334 if ( ! man_valid_post(m))
336 if ( ! man_action_post(m))
343 * Same here regarding whether we're back at the root.
346 if (m->last->type != MAN_ROOT && ! man_valid_post(m))
348 if (m->last->type != MAN_ROOT && ! man_action_post(m))
350 if (m->last->type != MAN_ROOT)
351 m->next = MAN_NEXT_SIBLING;
358 man_macroend(struct man *m)
362 n = MAN_VALID & m->last->flags ?
363 m->last->parent : m->last;
365 for ( ; n; n = n->parent) {
366 if (MAN_BLOCK != n->type)
368 if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
370 if ( ! man_nwarn(m, n, WEXITSCOPE))
374 return(man_unscope(m, m->first));