1 /* $Id: man_macro.c,v 1.123 2017/06/25 11:45:37 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2012-2015, 2017 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 AUTHORS DISCLAIM ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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>
31 #include "libmandoc.h"
35 static void blk_close(MACRO_PROT_ARGS);
36 static void blk_exp(MACRO_PROT_ARGS);
37 static void blk_imp(MACRO_PROT_ARGS);
38 static void in_line_eoln(MACRO_PROT_ARGS);
39 static int man_args(struct roff_man *, int,
40 int *, char *, char **);
41 static void rew_scope(struct roff_man *, enum roff_tok);
43 const struct man_macro __man_macros[MAN_MAX - MAN_TH] = {
44 { in_line_eoln, MAN_BSCOPE }, /* TH */
45 { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
46 { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
47 { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TP */
48 { blk_imp, MAN_BSCOPE }, /* LP */
49 { blk_imp, MAN_BSCOPE }, /* PP */
50 { blk_imp, MAN_BSCOPE }, /* P */
51 { blk_imp, MAN_BSCOPE }, /* IP */
52 { blk_imp, MAN_BSCOPE }, /* HP */
53 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
54 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
55 { in_line_eoln, 0 }, /* BI */
56 { in_line_eoln, 0 }, /* IB */
57 { in_line_eoln, 0 }, /* BR */
58 { in_line_eoln, 0 }, /* RB */
59 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
60 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
61 { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
62 { in_line_eoln, 0 }, /* IR */
63 { in_line_eoln, 0 }, /* RI */
64 { in_line_eoln, MAN_NSCOPED }, /* nf */
65 { in_line_eoln, MAN_NSCOPED }, /* fi */
66 { blk_close, MAN_BSCOPE }, /* RE */
67 { blk_exp, MAN_BSCOPE }, /* RS */
68 { in_line_eoln, 0 }, /* DT */
69 { in_line_eoln, 0 }, /* UC */
70 { in_line_eoln, MAN_NSCOPED }, /* PD */
71 { in_line_eoln, 0 }, /* AT */
72 { in_line_eoln, MAN_NSCOPED }, /* in */
73 { in_line_eoln, 0 }, /* OP */
74 { in_line_eoln, MAN_BSCOPE }, /* EX */
75 { in_line_eoln, MAN_BSCOPE }, /* EE */
76 { blk_exp, MAN_BSCOPE }, /* UR */
77 { blk_close, MAN_BSCOPE }, /* UE */
78 { blk_exp, MAN_BSCOPE }, /* MT */
79 { blk_close, MAN_BSCOPE }, /* ME */
81 const struct man_macro *const man_macros = __man_macros - MAN_TH;
85 man_unscope(struct roff_man *man, const struct roff_node *to)
93 /* Reached the end of the document? */
95 if (to == NULL && ! (n->flags & NODE_VALID)) {
96 if (man->flags & (MAN_BLINE | MAN_ELINE) &&
97 man_macros[n->tok].flags & MAN_SCOPED) {
98 mandoc_vmsg(MANDOCERR_BLK_LINE,
99 man->parse, n->line, n->pos,
100 "EOF breaks %s", roff_name[n->tok]);
101 if (man->flags & MAN_ELINE)
102 man->flags &= ~MAN_ELINE;
104 assert(n->type == ROFFT_HEAD);
106 man->flags &= ~MAN_BLINE;
110 roff_node_delete(man, man->last);
113 if (n->type == ROFFT_BLOCK &&
114 man_macros[n->tok].fp == blk_exp)
115 mandoc_msg(MANDOCERR_BLK_NOEND,
116 man->parse, n->line, n->pos,
121 * We might delete the man->last node
122 * in the post-validation phase.
123 * Save a pointer to the parent such that
124 * we know where to continue the iteration.
129 man->last->flags |= NODE_VALID;
133 * If we ended up at the parent of the node we were
134 * supposed to rewind to, that means the target node
135 * got deleted, so add the next node we parse as a child
136 * of the parent instead of as a sibling of the target.
139 man->next = (man->last == to) ?
140 ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
144 * Rewinding entails ascending the parse tree until a coherent point,
145 * for example, the `SH' macro will close out any intervening `SS'
146 * scopes. When a scope is closed, it must be validated and actioned.
149 rew_scope(struct roff_man *man, enum roff_tok tok)
153 /* Preserve empty paragraphs before RS. */
156 if (tok == MAN_RS && n->child == NULL &&
157 (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
161 if (n->type == ROFFT_ROOT)
163 if (n->flags & NODE_VALID) {
167 if (n->type != ROFFT_BLOCK) {
168 if (n->parent->type == ROFFT_ROOT) {
176 if (tok != MAN_SH && (n->tok == MAN_SH ||
177 (tok != MAN_SS && (n->tok == MAN_SS ||
178 man_macros[n->tok].fp == blk_exp))))
187 * Close out a generic explicit macro.
190 blk_close(MACRO_PROT_ARGS)
193 const struct roff_node *nn;
201 if ( ! man_args(man, line, pos, buf, &p))
203 for (nn = man->last->parent; nn; nn = nn->parent)
204 if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
206 target = strtol(p, &p, 10);
208 mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
209 line, p - buf, "RE ... %s", p);
214 mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse,
215 line, ppos, "RE %d", target);
229 for (nn = man->last->parent; nn; nn = nn->parent)
230 if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
234 mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
235 line, ppos, roff_name[tok]);
236 rew_scope(man, MAN_PP);
238 line = man->last->line;
239 ppos = man->last->pos;
240 ntok = man->last->tok;
241 man_unscope(man, nn);
243 if (tok == MAN_RE && nn->head->aux > 0)
244 roff_setreg(man->roff, "an-margin",
247 /* Move a trailing paragraph behind the block. */
249 if (ntok == MAN_LP || ntok == MAN_PP || ntok == MAN_P) {
251 blk_imp(man, ntok, line, ppos, pos, buf);
257 blk_exp(MACRO_PROT_ARGS)
259 struct roff_node *head;
264 roff_block_alloc(man, line, ppos, tok);
265 head = roff_head_alloc(man, line, ppos, tok);
268 if (man_args(man, line, pos, buf, &p)) {
269 roff_word_alloc(man, line, la, p);
271 if (roff_getreg(man->roff, "an-margin") == 0)
272 roff_setreg(man->roff, "an-margin",
274 if ((head->aux = strtod(p, NULL) * 24.0) > 0)
275 roff_setreg(man->roff, "an-margin",
280 if (buf[*pos] != '\0')
281 mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, line,
282 *pos, "%s ... %s", roff_name[tok], buf + *pos);
284 man_unscope(man, head);
285 roff_body_alloc(man, line, ppos, tok);
289 * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
290 * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
291 * scopes, such as `SH' closing out an `SS', are defined in the rew
295 blk_imp(MACRO_PROT_ARGS)
302 n = roff_block_alloc(man, line, ppos, tok);
303 if (n->tok == MAN_SH || n->tok == MAN_SS)
304 man->flags &= ~MAN_LITERAL;
305 n = roff_head_alloc(man, line, ppos, tok);
307 /* Add line arguments. */
311 if ( ! man_args(man, line, pos, buf, &p))
313 roff_word_alloc(man, line, la, p);
317 * For macros having optional next-line scope,
318 * keep the head open if there were no arguments.
319 * For `TP', always keep the head open.
322 if (man_macros[tok].flags & MAN_SCOPED &&
323 (tok == MAN_TP || n == man->last)) {
324 man->flags |= MAN_BLINE;
328 /* Close out the head and open the body. */
331 roff_body_alloc(man, line, ppos, tok);
335 in_line_eoln(MACRO_PROT_ARGS)
341 roff_elem_alloc(man, line, ppos, tok);
345 if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
346 mandoc_vmsg(MANDOCERR_ARG_SKIP,
347 man->parse, line, *pos, "%s %s",
348 roff_name[tok], buf + *pos);
351 if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
352 mandoc_vmsg(MANDOCERR_ARG_EXCESS,
353 man->parse, line, *pos, "%s ... %s",
354 roff_name[tok], buf + *pos);
358 if ( ! man_args(man, line, pos, buf, &p))
360 if (man_macros[tok].flags & MAN_JOIN &&
361 man->last->type == ROFFT_TEXT)
362 roff_word_append(man, p);
364 roff_word_alloc(man, line, la, p);
368 * Append NODE_EOS in case the last snipped argument
369 * ends with a dot, e.g. `.IR syslog (3).'
372 if (n != man->last &&
373 mandoc_eos(man->last->string, strlen(man->last->string)))
374 man->last->flags |= NODE_EOS;
377 * If no arguments are specified and this is MAN_SCOPED (i.e.,
378 * next-line scoped), then set our mode to indicate that we're
379 * waiting for terms to load into our context.
382 if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
383 assert( ! (man_macros[tok].flags & MAN_NSCOPED));
384 man->flags |= MAN_ELINE;
388 assert(man->last->type != ROFFT_ROOT);
389 man->next = ROFF_NEXT_SIBLING;
391 /* Rewind our element scope. */
393 for ( ; man->last; man->last = man->last->parent) {
394 man_state(man, man->last);
401 man_endparse(struct roff_man *man)
404 man_unscope(man, man->first);
405 man->flags &= ~MAN_LITERAL;
409 man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
414 *v = start = buf + *pos;
415 assert(' ' != *start);
420 *v = mandoc_getarg(man->parse, v, line, pos);