1 /* $Id: man_macro.c,v 1.75 2012/11/17 00:26:33 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2012 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
29 #include "libmandoc.h"
38 static int blk_close(MACRO_PROT_ARGS);
39 static int blk_exp(MACRO_PROT_ARGS);
40 static int blk_imp(MACRO_PROT_ARGS);
41 static int in_line_eoln(MACRO_PROT_ARGS);
42 static int man_args(struct man *, int,
43 int *, char *, char **);
45 static int rew_scope(enum man_type,
46 struct man *, enum mant);
47 static enum rew rew_dohalt(enum mant, enum man_type,
48 const struct man_node *);
49 static enum rew rew_block(enum mant, enum man_type,
50 const struct man_node *);
51 static void rew_warn(struct man *,
52 struct man_node *, enum mandocerr);
54 const struct man_macro __man_macros[MAN_MAX] = {
55 { in_line_eoln, MAN_NSCOPED }, /* br */
56 { in_line_eoln, MAN_BSCOPE }, /* TH */
57 { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
58 { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
59 { blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */
60 { blk_imp, MAN_BSCOPE }, /* LP */
61 { blk_imp, MAN_BSCOPE }, /* PP */
62 { blk_imp, MAN_BSCOPE }, /* P */
63 { blk_imp, MAN_BSCOPE }, /* IP */
64 { blk_imp, MAN_BSCOPE }, /* HP */
65 { in_line_eoln, MAN_SCOPED }, /* SM */
66 { in_line_eoln, MAN_SCOPED }, /* SB */
67 { in_line_eoln, 0 }, /* BI */
68 { in_line_eoln, 0 }, /* IB */
69 { in_line_eoln, 0 }, /* BR */
70 { in_line_eoln, 0 }, /* RB */
71 { in_line_eoln, MAN_SCOPED }, /* R */
72 { in_line_eoln, MAN_SCOPED }, /* B */
73 { in_line_eoln, MAN_SCOPED }, /* I */
74 { in_line_eoln, 0 }, /* IR */
75 { in_line_eoln, 0 }, /* RI */
76 { in_line_eoln, MAN_NSCOPED }, /* na */
77 { in_line_eoln, MAN_NSCOPED }, /* sp */
78 { in_line_eoln, MAN_BSCOPE }, /* nf */
79 { in_line_eoln, MAN_BSCOPE }, /* fi */
80 { blk_close, 0 }, /* RE */
81 { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */
82 { in_line_eoln, 0 }, /* DT */
83 { in_line_eoln, 0 }, /* UC */
84 { in_line_eoln, 0 }, /* PD */
85 { in_line_eoln, 0 }, /* AT */
86 { in_line_eoln, 0 }, /* in */
87 { in_line_eoln, 0 }, /* ft */
88 { in_line_eoln, 0 }, /* OP */
89 { in_line_eoln, MAN_BSCOPE }, /* EX */
90 { in_line_eoln, MAN_BSCOPE }, /* EE */
93 const struct man_macro * const man_macros = __man_macros;
97 * Warn when "n" is an explicit non-roff macro.
100 rew_warn(struct man *man, struct man_node *n, enum mandocerr er)
103 if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
105 if (MAN_VALID & n->flags)
107 if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
110 assert(er < MANDOCERR_FATAL);
111 man_nmsg(man, n, er);
116 * Rewind scope. If a code "er" != MANDOCERR_MAX has been provided, it
117 * will be used if an explicit block scope is being closed out.
120 man_unscope(struct man *man, const struct man_node *to,
127 man->next = MAN_NEXT_SIBLING;
130 while (man->last != to) {
132 * Save the parent here, because we may delete the
133 * man->last node in the post-validation phase and reset
134 * it to man->last->parent, causing a step in the closing
137 n = man->last->parent;
138 rew_warn(man, man->last, er);
139 if ( ! man_valid_post(man))
145 rew_warn(man, man->last, er);
146 if ( ! man_valid_post(man))
154 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
157 if (MAN_BLOCK == type && ntok == n->parent->tok &&
158 MAN_BODY == n->parent->type)
160 return(ntok == n->tok ? REW_HALT : REW_NOHALT);
165 * There are three scope levels: scoped to the root (all), scoped to the
166 * section (all less sections), and scoped to subsections (all less
167 * sections and subsections).
170 rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
174 /* We cannot progress beyond the root ever. */
175 if (MAN_ROOT == n->type)
180 /* Normal nodes shouldn't go to the level of the root. */
181 if (MAN_ROOT == n->parent->type)
184 /* Already-validated nodes should be closed out. */
185 if (MAN_VALID & n->flags)
188 /* First: rewind to ourselves. */
189 if (type == n->type && tok == n->tok) {
190 if (MAN_EXPLICIT & man_macros[n->tok].flags)
197 * Next follow the implicit scope-smashings as defined by man.7:
198 * section, sub-section, etc.
205 /* Rewind to a section, if a block. */
206 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
210 /* Preserve empty paragraphs before RS. */
211 if (0 == n->nchild && (MAN_P == n->tok ||
212 MAN_PP == n->tok || MAN_LP == n->tok))
214 /* Rewind to a subsection, if a block. */
215 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
217 /* Rewind to a section, if a block. */
218 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
222 /* Rewind to an offsetter, if a block. */
223 if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
225 /* Rewind to a subsection, if a block. */
226 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
228 /* Rewind to a section, if a block. */
229 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
239 * Rewinding entails ascending the parse tree until a coherent point,
240 * for example, the `SH' macro will close out any intervening `SS'
241 * scopes. When a scope is closed, it must be validated and actioned.
244 rew_scope(enum man_type type, struct man *man, enum mant tok)
250 for (n = man->last; n; n = n->parent) {
252 * Whether we should stop immediately (REW_HALT), stop
253 * and rewind until this point (REW_REWIND), or keep
254 * rewinding (REW_NOHALT).
256 c = rew_dohalt(tok, type, n);
264 * Rewind until the current point. Warn if we're a roff
265 * instruction that's mowing over explicit scopes.
269 return(man_unscope(man, n, MANDOCERR_MAX));
274 * Close out a generic explicit macro.
278 blk_close(MACRO_PROT_ARGS)
281 const struct man_node *nn;
292 for (nn = man->last->parent; nn; nn = nn->parent)
293 if (ntok == nn->tok && MAN_BLOCK == nn->type)
297 man_unscope(man, nn, MANDOCERR_MAX);
299 man_pmsg(man, line, ppos, MANDOCERR_NOSCOPE);
307 blk_exp(MACRO_PROT_ARGS)
313 /* Close out prior implicit scopes. */
315 if ( ! rew_scope(MAN_BLOCK, man, tok))
318 if ( ! man_block_alloc(man, line, ppos, tok))
320 if ( ! man_head_alloc(man, line, ppos, tok))
325 if ( ! man_args(man, line, pos, buf, &p))
327 if ( ! man_word_alloc(man, line, la, p))
332 assert(tok != MAN_MAX);
334 for (n = man->last; n; n = n->parent) {
337 assert(MAN_HEAD == n->type);
338 man_unscope(man, n, MANDOCERR_MAX);
342 return(man_body_alloc(man, line, ppos, tok));
348 * Parse an implicit-block macro. These contain a MAN_HEAD and a
349 * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
350 * scopes, such as `SH' closing out an `SS', are defined in the rew
355 blk_imp(MACRO_PROT_ARGS)
361 /* Close out prior scopes. */
363 if ( ! rew_scope(MAN_BODY, man, tok))
365 if ( ! rew_scope(MAN_BLOCK, man, tok))
368 /* Allocate new block & head scope. */
370 if ( ! man_block_alloc(man, line, ppos, tok))
372 if ( ! man_head_alloc(man, line, ppos, tok))
377 /* Add line arguments. */
381 if ( ! man_args(man, line, pos, buf, &p))
383 if ( ! man_word_alloc(man, line, la, p))
387 /* Close out head and open body (unless MAN_SCOPE). */
389 if (MAN_SCOPED & man_macros[tok].flags) {
390 /* If we're forcing scope (`TP'), keep it open. */
391 if (MAN_FSCOPED & man_macros[tok].flags) {
392 man->flags |= MAN_BLINE;
394 } else if (n == man->last) {
395 man->flags |= MAN_BLINE;
400 if ( ! rew_scope(MAN_HEAD, man, tok))
402 return(man_body_alloc(man, line, ppos, tok));
408 in_line_eoln(MACRO_PROT_ARGS)
414 if ( ! man_elem_alloc(man, line, ppos, tok))
421 if ( ! man_args(man, line, pos, buf, &p))
423 if ( ! man_word_alloc(man, line, la, p))
428 * If no arguments are specified and this is MAN_SCOPED (i.e.,
429 * next-line scoped), then set our mode to indicate that we're
430 * waiting for terms to load into our context.
433 if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {
434 assert( ! (MAN_NSCOPED & man_macros[tok].flags));
435 man->flags |= MAN_ELINE;
439 /* Set ignorable context, if applicable. */
441 if (MAN_NSCOPED & man_macros[tok].flags) {
442 assert( ! (MAN_SCOPED & man_macros[tok].flags));
443 man->flags |= MAN_ILINE;
446 assert(MAN_ROOT != man->last->type);
447 man->next = MAN_NEXT_SIBLING;
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
455 for ( ; man->last; man->last = man->last->parent) {
458 if (man->last->type == MAN_ROOT)
460 if ( ! man_valid_post(man))
467 * Same here regarding whether we're back at the root.
470 if (man->last->type != MAN_ROOT && ! man_valid_post(man))
478 man_macroend(struct man *man)
481 return(man_unscope(man, man->first, MANDOCERR_SCOPEEXIT));
485 man_args(struct man *man, int line, int *pos, char *buf, char **v)
490 *v = start = buf + *pos;
491 assert(' ' != *start);
496 *v = mandoc_getarg(man->parse, v, line, pos);