1 /* $Id: man_macro.c,v 1.91 2014/11/28 05:51:32 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
5 * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <sys/types.h>
30 #include "libmandoc.h"
39 static void blk_close(MACRO_PROT_ARGS);
40 static void blk_exp(MACRO_PROT_ARGS);
41 static void blk_imp(MACRO_PROT_ARGS);
42 static void in_line_eoln(MACRO_PROT_ARGS);
43 static int man_args(struct man *, int,
44 int *, char *, char **);
46 static void rew_scope(enum man_type,
47 struct man *, enum mant);
48 static enum rew rew_dohalt(enum mant, enum man_type,
49 const struct man_node *);
50 static enum rew rew_block(enum mant, enum man_type,
51 const struct man_node *);
53 const struct man_macro __man_macros[MAN_MAX] = {
54 { in_line_eoln, MAN_NSCOPED }, /* br */
55 { in_line_eoln, MAN_BSCOPE }, /* TH */
56 { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
57 { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
58 { blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */
59 { blk_imp, MAN_BSCOPE }, /* LP */
60 { blk_imp, MAN_BSCOPE }, /* PP */
61 { blk_imp, MAN_BSCOPE }, /* P */
62 { blk_imp, MAN_BSCOPE }, /* IP */
63 { blk_imp, MAN_BSCOPE }, /* HP */
64 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
65 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
66 { in_line_eoln, 0 }, /* BI */
67 { in_line_eoln, 0 }, /* IB */
68 { in_line_eoln, 0 }, /* BR */
69 { in_line_eoln, 0 }, /* RB */
70 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
71 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
72 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
73 { in_line_eoln, 0 }, /* IR */
74 { in_line_eoln, 0 }, /* RI */
75 { in_line_eoln, MAN_NSCOPED }, /* na */
76 { in_line_eoln, MAN_NSCOPED }, /* sp */
77 { in_line_eoln, MAN_BSCOPE }, /* nf */
78 { in_line_eoln, MAN_BSCOPE }, /* fi */
79 { blk_close, 0 }, /* RE */
80 { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */
81 { in_line_eoln, 0 }, /* DT */
82 { in_line_eoln, 0 }, /* UC */
83 { in_line_eoln, 0 }, /* PD */
84 { in_line_eoln, 0 }, /* AT */
85 { in_line_eoln, 0 }, /* in */
86 { in_line_eoln, 0 }, /* ft */
87 { in_line_eoln, 0 }, /* OP */
88 { in_line_eoln, MAN_BSCOPE }, /* EX */
89 { in_line_eoln, MAN_BSCOPE }, /* EE */
90 { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */
91 { blk_close, 0 }, /* UE */
92 { in_line_eoln, 0 }, /* ll */
95 const struct man_macro * const man_macros = __man_macros;
99 man_unscope(struct man *man, const struct man_node *to)
107 /* Reached the end of the document? */
109 if (to == NULL && ! (n->flags & MAN_VALID)) {
110 if (man->flags & (MAN_BLINE | MAN_ELINE) &&
111 man_macros[n->tok].flags & MAN_SCOPED) {
112 mandoc_vmsg(MANDOCERR_BLK_LINE,
113 man->parse, n->line, n->pos,
115 man_macronames[n->tok]);
116 if (man->flags & MAN_ELINE)
117 man->flags &= ~MAN_ELINE;
119 assert(n->type == MAN_HEAD);
121 man->flags &= ~MAN_BLINE;
125 man_node_delete(man, man->last);
128 if (n->type == MAN_BLOCK &&
129 man_macros[n->tok].flags & MAN_EXPLICIT)
130 mandoc_msg(MANDOCERR_BLK_NOEND,
131 man->parse, n->line, n->pos,
132 man_macronames[n->tok]);
136 * We might delete the man->last node
137 * in the post-validation phase.
138 * Save a pointer to the parent such that
139 * we know where to continue the iteration.
148 * If we ended up at the parent of the node we were
149 * supposed to rewind to, that means the target node
150 * got deleted, so add the next node we parse as a child
151 * of the parent instead of as a sibling of the target.
154 man->next = (man->last == to) ?
155 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
159 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
162 if (type == MAN_BLOCK && ntok == n->parent->tok &&
163 n->parent->type == MAN_BODY)
165 return(ntok == n->tok ? REW_HALT : REW_NOHALT);
169 * There are three scope levels: scoped to the root (all), scoped to the
170 * section (all less sections), and scoped to subsections (all less
171 * sections and subsections).
174 rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
178 /* We cannot progress beyond the root ever. */
179 if (MAN_ROOT == n->type)
184 /* Normal nodes shouldn't go to the level of the root. */
185 if (MAN_ROOT == n->parent->type)
188 /* Already-validated nodes should be closed out. */
189 if (MAN_VALID & n->flags)
192 /* First: rewind to ourselves. */
193 if (type == n->type && tok == n->tok) {
194 if (MAN_EXPLICIT & man_macros[n->tok].flags)
201 * Next follow the implicit scope-smashings as defined by man.7:
202 * section, sub-section, etc.
209 /* Rewind to a section, if a block. */
210 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
214 /* Preserve empty paragraphs before RS. */
215 if (0 == n->nchild && (MAN_P == n->tok ||
216 MAN_PP == n->tok || MAN_LP == n->tok))
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)))
242 * Rewinding entails ascending the parse tree until a coherent point,
243 * for example, the `SH' macro will close out any intervening `SS'
244 * scopes. When a scope is closed, it must be validated and actioned.
247 rew_scope(enum man_type type, struct man *man, enum mant tok)
252 for (n = man->last; n; n = n->parent) {
254 * Whether we should stop immediately (REW_HALT), stop
255 * and rewind until this point (REW_REWIND), or keep
256 * rewinding (REW_NOHALT).
258 c = rew_dohalt(tok, type, n);
266 * Rewind until the current point. Warn if we're a roff
267 * instruction that's mowing over explicit scopes.
275 * Close out a generic explicit macro.
278 blk_close(MACRO_PROT_ARGS)
281 const struct man_node *nn;
295 for (nn = man->last->parent; nn; nn = nn->parent)
296 if (nn->tok == ntok && nn->type == MAN_BLOCK)
300 mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
301 line, ppos, man_macronames[tok]);
302 rew_scope(MAN_BLOCK, man, MAN_PP);
304 man_unscope(man, nn);
308 blk_exp(MACRO_PROT_ARGS)
314 rew_scope(MAN_BLOCK, man, tok);
315 man_block_alloc(man, line, ppos, tok);
316 man_head_alloc(man, line, ppos, tok);
320 if ( ! man_args(man, line, pos, buf, &p))
322 man_word_alloc(man, line, la, p);
326 assert(tok != MAN_MAX);
328 for (n = man->last; n; n = n->parent)
330 assert(n->type == MAN_HEAD);
335 man_body_alloc(man, line, ppos, tok);
339 * Parse an implicit-block macro. These contain a MAN_HEAD and a
340 * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
341 * scopes, such as `SH' closing out an `SS', are defined in the rew
345 blk_imp(MACRO_PROT_ARGS)
351 rew_scope(MAN_BODY, man, tok);
352 rew_scope(MAN_BLOCK, man, tok);
353 man_block_alloc(man, line, ppos, tok);
354 man_head_alloc(man, line, ppos, tok);
357 /* Add line arguments. */
361 if ( ! man_args(man, line, pos, buf, &p))
363 man_word_alloc(man, line, la, p);
366 /* Close out head and open body (unless MAN_SCOPE). */
368 if (man_macros[tok].flags & MAN_SCOPED) {
369 /* If we're forcing scope (`TP'), keep it open. */
370 if (man_macros[tok].flags & MAN_FSCOPED) {
371 man->flags |= MAN_BLINE;
373 } else if (n == man->last) {
374 man->flags |= MAN_BLINE;
378 rew_scope(MAN_HEAD, man, tok);
379 man_body_alloc(man, line, ppos, tok);
383 in_line_eoln(MACRO_PROT_ARGS)
389 man_elem_alloc(man, line, ppos, tok);
394 if ( ! man_args(man, line, pos, buf, &p))
396 if (man_macros[tok].flags & MAN_JOIN &&
397 man->last->type == MAN_TEXT)
398 man_word_append(man, p);
400 man_word_alloc(man, line, la, p);
404 * Append MAN_EOS in case the last snipped argument
405 * ends with a dot, e.g. `.IR syslog (3).'
408 if (n != man->last &&
409 mandoc_eos(man->last->string, strlen(man->last->string)))
410 man->last->flags |= MAN_EOS;
413 * If no arguments are specified and this is MAN_SCOPED (i.e.,
414 * next-line scoped), then set our mode to indicate that we're
415 * waiting for terms to load into our context.
418 if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
419 assert( ! (man_macros[tok].flags & MAN_NSCOPED));
420 man->flags |= MAN_ELINE;
424 assert(man->last->type != MAN_ROOT);
425 man->next = MAN_NEXT_SIBLING;
428 * Rewind our element scope. Note that when TH is pruned, we'll
429 * be back at the root, so make sure that we don't clobber as
433 for ( ; man->last; man->last = man->last->parent) {
436 if (man->last->type == MAN_ROOT)
444 * Same here regarding whether we're back at the root.
447 if (man->last->type != MAN_ROOT)
453 man_macroend(struct man *man)
456 man_unscope(man, man->first);
460 man_args(struct man *man, int line, int *pos, char *buf, char **v)
465 *v = start = buf + *pos;
466 assert(' ' != *start);
471 *v = mandoc_getarg(man->parse, v, line, pos);