1 /* $Id: mdoc_macro.c,v 1.232 2019/01/07 07:26:29 schwarze Exp $ */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012-2019 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 AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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.
20 #include <sys/types.h>
32 #include "libmandoc.h"
36 static void blk_full(MACRO_PROT_ARGS);
37 static void blk_exp_close(MACRO_PROT_ARGS);
38 static void blk_part_exp(MACRO_PROT_ARGS);
39 static void blk_part_imp(MACRO_PROT_ARGS);
40 static void ctx_synopsis(MACRO_PROT_ARGS);
41 static void in_line_eoln(MACRO_PROT_ARGS);
42 static void in_line_argn(MACRO_PROT_ARGS);
43 static void in_line(MACRO_PROT_ARGS);
44 static void phrase_ta(MACRO_PROT_ARGS);
46 static void append_delims(struct roff_man *, int, int *, char *);
47 static void dword(struct roff_man *, int, int, const char *,
49 static int find_pending(struct roff_man *, enum roff_tok,
50 int, int, struct roff_node *);
51 static int lookup(struct roff_man *, int, int, int, const char *);
52 static int macro_or_word(MACRO_PROT_ARGS, char *, int);
53 static void break_intermediate(struct roff_node *,
55 static int parse_rest(struct roff_man *, enum roff_tok,
57 static enum roff_tok rew_alt(enum roff_tok);
58 static void rew_elem(struct roff_man *, enum roff_tok);
59 static void rew_last(struct roff_man *, const struct roff_node *);
60 static void rew_pending(struct roff_man *,
61 const struct roff_node *);
63 static const struct mdoc_macro mdoc_macros[MDOC_MAX - MDOC_Dd] = {
64 { in_line_eoln, MDOC_PROLOGUE }, /* Dd */
65 { in_line_eoln, MDOC_PROLOGUE }, /* Dt */
66 { in_line_eoln, MDOC_PROLOGUE }, /* Os */
67 { blk_full, MDOC_PARSED | MDOC_JOIN }, /* Sh */
68 { blk_full, MDOC_PARSED | MDOC_JOIN }, /* Ss */
69 { in_line_eoln, 0 }, /* Pp */
70 { blk_part_imp, MDOC_PARSED | MDOC_JOIN }, /* D1 */
71 { blk_part_imp, MDOC_PARSED | MDOC_JOIN }, /* Dl */
72 { blk_full, MDOC_EXPLICIT }, /* Bd */
73 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ed */
74 { blk_full, MDOC_EXPLICIT }, /* Bl */
75 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* El */
76 { blk_full, MDOC_PARSED | MDOC_JOIN }, /* It */
77 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
78 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* An */
79 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED |
80 MDOC_IGNDELIM | MDOC_JOIN }, /* Ap */
81 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
82 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Cd */
83 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
84 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
85 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
86 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
87 { in_line_eoln, 0 }, /* Ex */
88 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */
89 { in_line_eoln, 0 }, /* Fd */
90 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
91 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */
92 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */
93 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ic */
94 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */
95 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Li */
96 { blk_full, MDOC_JOIN }, /* Nd */
97 { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
98 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
99 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ot */
100 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
101 { in_line_eoln, 0 }, /* Rv */
102 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */
103 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
104 { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
105 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
106 { in_line_eoln, MDOC_JOIN }, /* %A */
107 { in_line_eoln, MDOC_JOIN }, /* %B */
108 { in_line_eoln, MDOC_JOIN }, /* %D */
109 { in_line_eoln, MDOC_JOIN }, /* %I */
110 { in_line_eoln, MDOC_JOIN }, /* %J */
111 { in_line_eoln, 0 }, /* %N */
112 { in_line_eoln, MDOC_JOIN }, /* %O */
113 { in_line_eoln, 0 }, /* %P */
114 { in_line_eoln, MDOC_JOIN }, /* %R */
115 { in_line_eoln, MDOC_JOIN }, /* %T */
116 { in_line_eoln, 0 }, /* %V */
117 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
118 MDOC_EXPLICIT | MDOC_JOIN }, /* Ac */
119 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
120 MDOC_EXPLICIT | MDOC_JOIN }, /* Ao */
121 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Aq */
122 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* At */
123 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
124 MDOC_EXPLICIT | MDOC_JOIN }, /* Bc */
125 { blk_full, MDOC_EXPLICIT }, /* Bf */
126 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
127 MDOC_EXPLICIT | MDOC_JOIN }, /* Bo */
128 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Bq */
129 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */
130 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */
131 { in_line_eoln, 0 }, /* Db */
132 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
133 MDOC_EXPLICIT | MDOC_JOIN }, /* Dc */
134 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
135 MDOC_EXPLICIT | MDOC_JOIN }, /* Do */
136 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Dq */
137 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ec */
138 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ef */
139 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Em */
140 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
141 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */
142 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */
143 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* No */
144 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED |
145 MDOC_IGNDELIM | MDOC_JOIN }, /* Ns */
146 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
147 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
148 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
149 MDOC_EXPLICIT | MDOC_JOIN }, /* Pc */
150 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
151 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
152 MDOC_EXPLICIT | MDOC_JOIN }, /* Po */
153 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Pq */
154 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
155 MDOC_EXPLICIT | MDOC_JOIN }, /* Qc */
156 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ql */
157 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
158 MDOC_EXPLICIT | MDOC_JOIN }, /* Qo */
159 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Qq */
160 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Re */
161 { blk_full, MDOC_EXPLICIT }, /* Rs */
162 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
163 MDOC_EXPLICIT | MDOC_JOIN }, /* Sc */
164 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
165 MDOC_EXPLICIT | MDOC_JOIN }, /* So */
166 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sq */
167 { in_line_argn, 0 }, /* Sm */
168 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sx */
169 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sy */
170 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
171 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ux */
172 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
173 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
174 { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
175 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
176 MDOC_EXPLICIT | MDOC_JOIN }, /* Fc */
177 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
178 MDOC_EXPLICIT | MDOC_JOIN }, /* Oo */
179 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
180 MDOC_EXPLICIT | MDOC_JOIN }, /* Oc */
181 { blk_full, MDOC_EXPLICIT }, /* Bk */
182 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ek */
183 { in_line_eoln, 0 }, /* Bt */
184 { in_line_eoln, 0 }, /* Hf */
185 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fr */
186 { in_line_eoln, 0 }, /* Ud */
187 { in_line, 0 }, /* Lb */
188 { in_line_eoln, 0 }, /* Lp */
189 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
190 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
191 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Brq */
192 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
193 MDOC_EXPLICIT | MDOC_JOIN }, /* Bro */
194 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
195 MDOC_EXPLICIT | MDOC_JOIN }, /* Brc */
196 { in_line_eoln, MDOC_JOIN }, /* %C */
197 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Es */
198 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* En */
199 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
200 { in_line_eoln, MDOC_JOIN }, /* %Q */
201 { in_line_eoln, 0 }, /* %U */
202 { phrase_ta, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ta */
206 const struct mdoc_macro *
207 mdoc_macro(enum roff_tok tok)
209 assert(tok >= MDOC_Dd && tok < MDOC_MAX);
210 return mdoc_macros + (tok - MDOC_Dd);
214 * This is called at the end of parsing. It must traverse up the tree,
215 * closing out open [implicit] scopes. Obviously, open explicit scopes
219 mdoc_endparse(struct roff_man *mdoc)
223 /* Scan for open explicit scopes. */
225 n = mdoc->last->flags & NODE_VALID ?
226 mdoc->last->parent : mdoc->last;
228 for ( ; n; n = n->parent)
229 if (n->type == ROFFT_BLOCK &&
230 mdoc_macro(n->tok)->flags & MDOC_EXPLICIT)
231 mandoc_msg(MANDOCERR_BLK_NOEND,
232 n->line, n->pos, "%s", roff_name[n->tok]);
234 /* Rewind to the first. */
236 rew_last(mdoc, mdoc->meta.first);
240 * Look up the macro at *p called by "from",
241 * or as a line macro if from == TOKEN_NONE.
244 lookup(struct roff_man *mdoc, int from, int line, int ppos, const char *p)
248 if (mdoc->flags & MDOC_PHRASEQF) {
249 mdoc->flags &= ~MDOC_PHRASEQF;
252 if (from == TOKEN_NONE || mdoc_macro(from)->flags & MDOC_PARSED) {
253 res = roffhash_find(mdoc->mdocmac, p, 0);
254 if (res != TOKEN_NONE) {
255 if (mdoc_macro(res)->flags & MDOC_CALLABLE)
257 mandoc_msg(MANDOCERR_MACRO_CALL, line, ppos, "%s", p);
264 * Rewind up to and including a specific node.
267 rew_last(struct roff_man *mdoc, const struct roff_node *to)
270 if (to->flags & NODE_VALID)
273 while (mdoc->last != to) {
274 mdoc_state(mdoc, mdoc->last);
275 mdoc->last->flags |= NODE_VALID | NODE_ENDED;
276 mdoc->last = mdoc->last->parent;
278 mdoc_state(mdoc, mdoc->last);
279 mdoc->last->flags |= NODE_VALID | NODE_ENDED;
280 mdoc->next = ROFF_NEXT_SIBLING;
284 * Rewind up to a specific block, including all blocks that broke it.
287 rew_pending(struct roff_man *mdoc, const struct roff_node *n)
293 if (mdoc->last == n) {
296 roff_body_alloc(mdoc, n->line, n->pos,
298 if (n->tok == MDOC_Ss)
299 mdoc->flags &= ~ROFF_NONOFILL;
306 if ( ! (n->flags & NODE_BROKEN))
312 if ((n = n->parent) == NULL)
315 if (n->type == ROFFT_BLOCK ||
316 n->type == ROFFT_HEAD) {
317 if (n->flags & NODE_ENDED)
327 * For a block closing macro, return the corresponding opening one.
328 * Otherwise, return the macro itself.
331 rew_alt(enum roff_tok tok)
372 rew_elem(struct roff_man *mdoc, enum roff_tok tok)
377 if (n->type != ROFFT_ELEM)
379 assert(n->type == ROFFT_ELEM);
380 assert(tok == n->tok);
385 break_intermediate(struct roff_node *n, struct roff_node *breaker)
388 n->type != ROFFT_BLOCK && n->type != ROFFT_HEAD &&
389 (n->type != ROFFT_BODY || n->end != ENDBODY_NOT))
391 while (n != breaker) {
392 if ( ! (n->flags & NODE_VALID))
393 n->flags |= NODE_BROKEN;
399 * If there is an open sub-block of the target requiring
400 * explicit close-out, postpone closing out the target until
401 * the rew_pending() call closing out the sub-block.
404 find_pending(struct roff_man *mdoc, enum roff_tok tok, int line, int ppos,
405 struct roff_node *target)
410 if (target->flags & NODE_VALID)
414 for (n = mdoc->last; n != NULL && n != target; n = n->parent) {
415 if (n->flags & NODE_ENDED)
417 if (n->type == ROFFT_BLOCK &&
418 mdoc_macro(n->tok)->flags & MDOC_EXPLICIT) {
420 break_intermediate(mdoc->last, target);
421 if (target->type == ROFFT_HEAD)
422 target->flags |= NODE_ENDED;
423 else if ( ! (target->flags & NODE_ENDED)) {
424 mandoc_msg(MANDOCERR_BLK_NEST,
425 line, ppos, "%s breaks %s",
426 roff_name[tok], roff_name[n->tok]);
427 mdoc_endbody_alloc(mdoc, line, ppos,
436 * Allocate a word and check whether it's punctuation or not.
437 * Punctuation consists of those tokens found in mdoc_isdelim().
440 dword(struct roff_man *mdoc, int line, int col, const char *p,
441 enum mdelim d, int may_append)
448 ! (mdoc->flags & (MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF)) &&
449 d == DELIM_NONE && mdoc->last->type == ROFFT_TEXT &&
450 mdoc_isdelim(mdoc->last->string) == DELIM_NONE) {
451 roff_word_append(mdoc, p);
455 roff_word_alloc(mdoc, line, col, p);
458 * If the word consists of a bare delimiter,
459 * flag the new node accordingly,
460 * unless doing so was vetoed by the invoking macro.
461 * Always clear the veto, it is only valid for one word.
465 mdoc->last->flags |= NODE_DELIMO;
466 else if (d == DELIM_CLOSE &&
467 ! (mdoc->flags & MDOC_NODELIMC) &&
468 mdoc->last->parent->tok != MDOC_Fd)
469 mdoc->last->flags |= NODE_DELIMC;
470 mdoc->flags &= ~MDOC_NODELIMC;
474 append_delims(struct roff_man *mdoc, int line, int *pos, char *buf)
480 if (buf[*pos] == '\0')
485 ac = mdoc_args(mdoc, line, pos, buf, TOKEN_NONE, &p);
488 dword(mdoc, line, la, p, DELIM_MAX, 1);
491 * If we encounter end-of-sentence symbols, then trigger
494 * XXX: it's easy to allow this to propagate outward to
495 * the last symbol, such that `. )' will cause the
496 * correct double-spacing. However, (1) groff isn't
497 * smart enough to do this and (2) it would require
498 * knowing which symbols break this behaviour, for
499 * example, `. ;' shouldn't propagate the double-space.
502 if (mandoc_eos(p, strlen(p)))
503 mdoc->last->flags |= NODE_EOS;
504 if (ac == ARGS_ALLOC)
511 * If it is a macro, call it and return 1.
512 * Otherwise, allocate it and return 0.
515 macro_or_word(MACRO_PROT_ARGS, char *p, int parsed)
519 ntok = buf[ppos] == '"' || parsed == 0 ||
520 mdoc->flags & MDOC_PHRASELIT ? TOKEN_NONE :
521 lookup(mdoc, tok, line, ppos, p);
523 if (ntok == TOKEN_NONE) {
524 dword(mdoc, line, ppos, p, DELIM_MAX, tok == TOKEN_NONE ||
525 mdoc_macro(tok)->flags & MDOC_JOIN);
528 if (tok != TOKEN_NONE &&
529 mdoc_macro(tok)->fp == in_line_eoln)
531 (*mdoc_macro(ntok)->fp)(mdoc, ntok, line, ppos, pos, buf);
532 if (tok == TOKEN_NONE)
533 append_delims(mdoc, line, pos, buf);
539 * Close out block partial/full explicit.
542 blk_exp_close(MACRO_PROT_ARGS)
544 struct roff_node *body; /* Our own body. */
545 struct roff_node *endbody; /* Our own end marker. */
546 struct roff_node *itblk; /* An It block starting later. */
547 struct roff_node *later; /* A sub-block starting later. */
548 struct roff_node *n; /* Search back to our block. */
549 struct roff_node *target; /* For find_pending(). */
551 int j, lastarg, maxargs, nl, pending;
553 enum roff_tok atok, ntok;
556 nl = MDOC_NEWLINE & mdoc->flags;
563 mdoc->flags &= ~MDOC_KEEP;
570 /* Search backwards for the beginning of our own body. */
574 for (n = mdoc->last; n; n = n->parent) {
575 if (n->flags & NODE_ENDED || n->tok != atok ||
576 n->type != ROFFT_BODY || n->end != ENDBODY_NOT)
583 * Search backwards for beginnings of blocks,
584 * both of our own and of pending sub-blocks.
587 endbody = itblk = later = NULL;
588 for (n = mdoc->last; n; n = n->parent) {
589 if (n->flags & NODE_ENDED)
593 * Mismatching end macros can never break anything
594 * and we only care about the breaking of BLOCKs.
597 if (body == NULL || n->type != ROFFT_BLOCK)
601 * SYNOPSIS name blocks can not be broken themselves,
602 * but they do get broken together with a broken child.
605 if (n->tok == MDOC_Nm) {
607 n->flags |= NODE_BROKEN | NODE_ENDED;
611 if (n->tok == MDOC_It) {
616 if (atok == n->tok) {
619 * Found the start of our own block.
620 * When there is no pending sub block,
621 * just proceed to closing out.
625 (tok == MDOC_El && itblk == NULL))
629 * When there is a pending sub block, postpone
630 * closing out the current block until the
631 * rew_pending() closing out the sub-block.
632 * Mark the place where the formatting - but not
633 * the scope - of the current block ends.
636 mandoc_msg(MANDOCERR_BLK_NEST,
637 line, ppos, "%s breaks %s",
638 roff_name[atok], roff_name[later->tok]);
640 endbody = mdoc_endbody_alloc(mdoc, line, ppos,
644 itblk->flags |= NODE_ENDED | NODE_BROKEN;
647 * If a block closing macro taking arguments
648 * breaks another block, put the arguments
649 * into the end marker.
653 mdoc->next = ROFF_NEXT_CHILD;
658 * Explicit blocks close out description lines, but
659 * even those can get broken together with a child.
662 if (n->tok == MDOC_Nd) {
664 n->flags |= NODE_BROKEN | NODE_ENDED;
670 /* Breaking an open sub block. */
672 break_intermediate(mdoc->last, body);
673 n->flags |= NODE_BROKEN;
679 mandoc_msg(MANDOCERR_BLK_NOTOPEN, line, ppos,
680 "%s", roff_name[tok]);
681 if (maxargs && endbody == NULL) {
683 * Stray .Ec without previous .Eo:
684 * Break the output line, keep the arguments.
686 roff_elem_alloc(mdoc, line, ppos, ROFF_br);
687 rew_elem(mdoc, ROFF_br);
689 } else if (endbody == NULL) {
690 rew_last(mdoc, body);
692 mdoc_tail_alloc(mdoc, line, ppos, atok);
695 if ((mdoc_macro(tok)->flags & MDOC_PARSED) == 0) {
696 if (buf[*pos] != '\0')
697 mandoc_msg(MANDOCERR_ARG_SKIP, line, ppos,
698 "%s %s", roff_name[tok], buf + *pos);
699 if (endbody == NULL && n != NULL)
700 rew_pending(mdoc, n);
703 * Restore the fill mode that was set before the display.
704 * This needs to be done here rather than during validation
705 * such that subsequent nodes get the right flags.
708 if (tok == MDOC_Ed && body != NULL) {
709 if (body->flags & NODE_NOFILL)
710 mdoc->flags |= ROFF_NOFILL;
712 mdoc->flags &= ~ROFF_NOFILL;
724 if (j == maxargs && n != NULL)
727 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
728 if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
731 ntok = lookup(mdoc, tok, line, lastarg, p);
733 if (ntok == TOKEN_NONE) {
734 dword(mdoc, line, lastarg, p, DELIM_MAX,
735 mdoc_macro(tok)->flags & MDOC_JOIN);
736 if (ac == ARGS_ALLOC)
740 if (ac == ARGS_ALLOC)
745 mdoc->flags &= ~MDOC_NEWLINE;
746 (*mdoc_macro(ntok)->fp)(mdoc, ntok, line, lastarg, pos, buf);
752 if (ntok != TOKEN_NONE && n->flags & NODE_BROKEN) {
755 target = target->parent;
756 while ( ! (target->flags & NODE_ENDED));
757 pending = find_pending(mdoc, ntok, line, ppos, target);
760 rew_pending(mdoc, n);
763 append_delims(mdoc, line, pos, buf);
767 in_line(MACRO_PROT_ARGS)
769 int la, scope, cnt, firstarg, mayopen, nc, nl;
773 struct mdoc_arg *arg;
776 nl = MDOC_NEWLINE & mdoc->flags;
779 * Whether we allow ignored elements (those without content,
780 * usually because of reserved words) to squeak by.
797 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
802 for (cnt = scope = 0;; ) {
804 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
807 * At the end of a macro line,
808 * opening delimiters do not suppress spacing.
811 if (ac == ARGS_EOLN) {
813 mdoc->last->flags &= ~NODE_DELIMO;
818 * The rest of the macro line is only punctuation,
819 * to be handled by append_delims().
820 * If there were no other arguments,
821 * do not allow the first one to suppress spacing,
822 * even if it turns out to be a closing one.
825 if (ac == ARGS_PUNCT) {
826 if (cnt == 0 && (nc == 0 || tok == MDOC_An))
827 mdoc->flags |= MDOC_NODELIMC;
831 ntok = (tok == MDOC_Fn && !cnt) ?
832 TOKEN_NONE : lookup(mdoc, tok, line, la, p);
835 * In this case, we've located a submacro and must
836 * execute it. Close out scope, if open. If no
837 * elements have been generated, either create one (nc)
838 * or raise a warning.
841 if (ntok != TOKEN_NONE) {
845 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
846 rew_last(mdoc, mdoc->last);
847 } else if ( ! nc && ! cnt) {
849 mandoc_msg(MANDOCERR_MACRO_EMPTY,
850 line, ppos, "%s", roff_name[tok]);
852 (*mdoc_macro(ntok)->fp)(mdoc, ntok,
855 append_delims(mdoc, line, pos, buf);
856 if (ac == ARGS_ALLOC)
862 * Handle punctuation. Set up our scope, if a word;
863 * rewind the scope, if a delimiter; then append the word.
866 if ((d = mdoc_isdelim(p)) != DELIM_NONE) {
868 * If we encounter closing punctuation, no word
869 * has been emitted, no scope is open, and we're
870 * allowed to have an empty element, then start
873 if ((d == DELIM_CLOSE ||
874 (d == DELIM_MIDDLE && tok == MDOC_Fl)) &&
875 !cnt && !scope && nc && mayopen) {
876 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
883 * Close out our scope, if one is open, before
886 if (scope && tok != MDOC_Lk) {
892 } else if (mayopen && !scope) {
893 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
898 dword(mdoc, line, la, p, d,
899 mdoc_macro(tok)->flags & MDOC_JOIN);
901 if (ac == ARGS_ALLOC)
905 * If the first argument is a closing delimiter,
906 * do not suppress spacing before it.
909 if (firstarg && d == DELIM_CLOSE && !nc)
910 mdoc->last->flags &= ~NODE_DELIMC;
914 * `Fl' macros have their scope re-opened with each new
915 * word so that the `-' can be added to each one without
916 * having to parse out spaces.
918 if (scope && tok == MDOC_Fl) {
924 if (scope && tok != MDOC_Lk) {
930 * If no elements have been collected and we're allowed to have
931 * empties (nc), open a scope and close it out. Otherwise,
937 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
938 rew_last(mdoc, mdoc->last);
941 mandoc_msg(MANDOCERR_MACRO_EMPTY,
942 line, ppos, "%s", roff_name[tok]);
946 append_delims(mdoc, line, pos, buf);
952 blk_full(MACRO_PROT_ARGS)
954 struct mdoc_arg *arg;
955 struct roff_node *blk; /* Our own or a broken block. */
956 struct roff_node *head; /* Our own head. */
957 struct roff_node *body; /* Our own body. */
961 int done, la, nl, parsed;
962 enum margserr ac, lac;
964 nl = MDOC_NEWLINE & mdoc->flags;
966 if (buf[*pos] == '\0' && (tok == MDOC_Sh || tok == MDOC_Ss)) {
967 mandoc_msg(MANDOCERR_MACRO_EMPTY,
968 line, ppos, "%s", roff_name[tok]);
972 if ((mdoc_macro(tok)->flags & MDOC_EXPLICIT) == 0) {
974 /* Here, tok is one of Sh Ss Nm Nd It. */
977 for (n = mdoc->last; n != NULL; n = n->parent) {
978 if (n->flags & NODE_ENDED) {
979 if ( ! (n->flags & NODE_VALID))
980 n->flags |= NODE_BROKEN;
983 if (n->type != ROFFT_BLOCK)
986 if (tok == MDOC_It && n->tok == MDOC_Bl) {
988 mandoc_msg(MANDOCERR_BLK_BROKEN,
989 line, ppos, "It breaks %s",
990 roff_name[blk->tok]);
991 rew_pending(mdoc, blk);
996 if (mdoc_macro(n->tok)->flags & MDOC_EXPLICIT) {
1000 mandoc_msg(MANDOCERR_BLK_BROKEN,
1002 "%s breaks %s", roff_name[tok],
1004 rew_pending(mdoc, n);
1008 /* Delay in case it's astray. */
1017 /* Here, n is one of Sh Ss Nm Nd It. */
1019 if (tok != MDOC_Sh && (n->tok == MDOC_Sh ||
1020 (tok != MDOC_Ss && (n->tok == MDOC_Ss ||
1021 (tok != MDOC_It && n->tok == MDOC_It)))))
1024 /* Item breaking an explicit block. */
1027 mandoc_msg(MANDOCERR_BLK_BROKEN, line, ppos,
1028 "It breaks %s", roff_name[blk->tok]);
1029 rew_pending(mdoc, blk);
1033 /* Close out prior implicit scopes. */
1035 rew_pending(mdoc, n);
1038 /* Skip items outside lists. */
1040 if (tok == MDOC_It && (n == NULL || n->tok != MDOC_Bl)) {
1041 mandoc_msg(MANDOCERR_IT_STRAY,
1042 line, ppos, "It %s", buf + *pos);
1043 roff_elem_alloc(mdoc, line, ppos, ROFF_br);
1044 rew_elem(mdoc, ROFF_br);
1050 * This routine accommodates implicitly- and explicitly-scoped
1051 * macro openings. Implicit ones first close out prior scope
1052 * (seen above). Delay opening the head until necessary to
1053 * allow leading punctuation to print. Special consideration
1054 * for `It -column', which has phrase-part syntax instead of
1055 * regular child nodes.
1060 mdoc->flags &= ~ROFF_NOFILL;
1063 mdoc->flags |= ROFF_NONOFILL;
1068 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1069 blk = mdoc_block_alloc(mdoc, line, ppos, tok, arg);
1073 * Exception: Heads of `It' macros in `-diag' lists are not
1074 * parsed, even though `It' macros in general are parsed.
1077 parsed = tok != MDOC_It ||
1078 mdoc->last->parent->tok != MDOC_Bl ||
1079 mdoc->last->parent->norm->Bl.type != LIST_diag;
1082 * The `Nd' macro has all arguments in its body: it's a hybrid
1083 * of block partial-explicit and full-implicit. Stupid.
1086 if (tok == MDOC_Nd) {
1087 head = roff_head_alloc(mdoc, line, ppos, tok);
1088 rew_last(mdoc, head);
1089 body = roff_body_alloc(mdoc, line, ppos, tok);
1093 mdoc->flags |= MDOC_KEEP;
1099 * If we are right after a tab character,
1100 * do not parse the first word for macros.
1103 if (mdoc->flags & MDOC_PHRASEQN) {
1104 mdoc->flags &= ~MDOC_PHRASEQN;
1105 mdoc->flags |= MDOC_PHRASEQF;
1110 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1111 if (ac == ARGS_EOLN) {
1112 if (lac != ARGS_PHRASE ||
1113 ! (mdoc->flags & MDOC_PHRASEQF))
1117 * This line ends in a tab; start the next
1118 * column now, with a leading blank.
1122 rew_last(mdoc, body);
1123 body = roff_body_alloc(mdoc, line, ppos, tok);
1124 roff_word_alloc(mdoc, line, ppos, "\\&");
1128 if (tok == MDOC_Bd || tok == MDOC_Bk) {
1129 mandoc_msg(MANDOCERR_ARG_EXCESS, line, la,
1130 "%s ... %s", roff_name[tok], buf + la);
1131 if (ac == ARGS_ALLOC)
1135 if (tok == MDOC_Rs) {
1136 mandoc_msg(MANDOCERR_ARG_SKIP,
1137 line, la, "Rs %s", buf + la);
1138 if (ac == ARGS_ALLOC)
1142 if (ac == ARGS_PUNCT)
1146 * Emit leading punctuation (i.e., punctuation before
1147 * the ROFFT_HEAD) for non-phrase types.
1151 ac != ARGS_PHRASE &&
1152 mdoc_isdelim(p) == DELIM_OPEN) {
1153 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1154 if (ac == ARGS_ALLOC)
1159 /* Open a head if one hasn't been opened. */
1162 head = roff_head_alloc(mdoc, line, ppos, tok);
1164 if (ac == ARGS_PHRASE) {
1167 * If we haven't opened a body yet, rewind the
1168 * head; if we have, rewind that instead.
1171 rew_last(mdoc, body == NULL ? head : body);
1172 body = roff_body_alloc(mdoc, line, ppos, tok);
1174 /* Process to the tab or to the end of the line. */
1176 mdoc->flags |= MDOC_PHRASE;
1177 parse_rest(mdoc, TOKEN_NONE, line, &la, buf);
1178 mdoc->flags &= ~MDOC_PHRASE;
1180 /* There may have been `Ta' macros. */
1182 while (body->next != NULL)
1187 done = macro_or_word(mdoc, tok, line, la, pos, buf, p, parsed);
1188 if (ac == ARGS_ALLOC)
1194 if (blk->flags & NODE_VALID)
1197 head = roff_head_alloc(mdoc, line, ppos, tok);
1198 if (nl && tok != MDOC_Bd && tok != MDOC_Bl && tok != MDOC_Rs)
1199 append_delims(mdoc, line, pos, buf);
1202 if (find_pending(mdoc, tok, line, ppos, head))
1205 /* Close out scopes to remain in a consistent state. */
1207 rew_last(mdoc, head);
1208 body = roff_body_alloc(mdoc, line, ppos, tok);
1210 mdoc->flags &= ~ROFF_NONOFILL;
1213 * Set up fill mode for display blocks.
1214 * This needs to be done here up front rather than during
1215 * validation such that child nodes get the right flags.
1218 if (tok == MDOC_Bd && arg != NULL) {
1219 for (iarg = 0; iarg < arg->argc; iarg++) {
1220 switch (arg->argv[iarg].arg) {
1223 mdoc->flags |= ROFF_NOFILL;
1228 mdoc->flags &= ~ROFF_NOFILL;
1237 if (mdoc->flags & MDOC_FREECOL) {
1238 rew_last(mdoc, body);
1239 rew_last(mdoc, blk);
1240 mdoc->flags &= ~MDOC_FREECOL;
1245 blk_part_imp(MACRO_PROT_ARGS)
1250 struct roff_node *blk; /* saved block context */
1251 struct roff_node *body; /* saved body context */
1252 struct roff_node *n;
1254 nl = MDOC_NEWLINE & mdoc->flags;
1257 * A macro that spans to the end of the line. This is generally
1258 * (but not necessarily) called as the first macro. The block
1259 * has a head as the immediate child, which is always empty,
1260 * followed by zero or more opening punctuation nodes, then the
1261 * body (which may be empty, depending on the macro), then zero
1262 * or more closing punctuation nodes.
1265 blk = mdoc_block_alloc(mdoc, line, ppos, tok, NULL);
1266 rew_last(mdoc, roff_head_alloc(mdoc, line, ppos, tok));
1269 * Open the body scope "on-demand", that is, after we've
1270 * processed all our the leading delimiters (open parenthesis,
1274 for (body = NULL; ; ) {
1276 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1277 if (ac == ARGS_EOLN || ac == ARGS_PUNCT)
1280 if (body == NULL && mdoc_isdelim(p) == DELIM_OPEN) {
1281 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1282 if (ac == ARGS_ALLOC)
1288 body = roff_body_alloc(mdoc, line, ppos, tok);
1290 done = macro_or_word(mdoc, tok, line, la, pos, buf, p, 1);
1291 if (ac == ARGS_ALLOC)
1297 body = roff_body_alloc(mdoc, line, ppos, tok);
1299 if (find_pending(mdoc, tok, line, ppos, body))
1302 rew_last(mdoc, body);
1304 append_delims(mdoc, line, pos, buf);
1305 rew_pending(mdoc, blk);
1307 /* Move trailing .Ns out of scope. */
1309 for (n = body->child; n && n->next; n = n->next)
1311 if (n && n->tok == MDOC_Ns)
1312 roff_node_relink(mdoc, n);
1316 blk_part_exp(MACRO_PROT_ARGS)
1320 struct roff_node *head; /* keep track of head */
1323 nl = MDOC_NEWLINE & mdoc->flags;
1326 * The opening of an explicit macro having zero or more leading
1327 * punctuation nodes; a head with optional single element (the
1328 * case of `Eo'); and a body that may be empty.
1331 roff_block_alloc(mdoc, line, ppos, tok);
1335 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1336 if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
1339 /* Flush out leading punctuation. */
1341 if (head == NULL && mdoc_isdelim(p) == DELIM_OPEN) {
1342 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1343 if (ac == ARGS_ALLOC)
1349 head = roff_head_alloc(mdoc, line, ppos, tok);
1350 if (tok == MDOC_Eo) /* Not parsed. */
1351 dword(mdoc, line, la, p, DELIM_MAX, 0);
1352 rew_last(mdoc, head);
1353 roff_body_alloc(mdoc, line, ppos, tok);
1354 if (tok == MDOC_Eo) {
1355 if (ac == ARGS_ALLOC)
1361 done = macro_or_word(mdoc, tok, line, la, pos, buf, p, 1);
1362 if (ac == ARGS_ALLOC)
1368 /* Clean-up to leave in a consistent state. */
1371 rew_last(mdoc, roff_head_alloc(mdoc, line, ppos, tok));
1372 roff_body_alloc(mdoc, line, ppos, tok);
1375 append_delims(mdoc, line, pos, buf);
1379 in_line_argn(MACRO_PROT_ARGS)
1381 struct mdoc_arg *arg;
1385 int state; /* arg#; -1: not yet open; -2: closed */
1386 int la, maxargs, nl;
1388 nl = mdoc->flags & MDOC_NEWLINE;
1391 * A line macro that has a fixed number of arguments (maxargs).
1392 * Only open the scope once the first non-leading-punctuation is
1393 * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1394 * keep it open until the maximum number of arguments are
1414 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1420 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1422 if ((ac == ARGS_WORD || ac == ARGS_ALLOC) && state == -1 &&
1423 (mdoc_macro(tok)->flags & MDOC_IGNDELIM) == 0 &&
1424 mdoc_isdelim(p) == DELIM_OPEN) {
1425 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1426 if (ac == ARGS_ALLOC)
1431 if (state == -1 && tok != MDOC_In &&
1432 tok != MDOC_St && tok != MDOC_Xr) {
1433 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1437 if (ac == ARGS_PUNCT || ac == ARGS_EOLN) {
1438 if (abs(state) < 2 && tok == MDOC_Pf)
1439 mandoc_msg(MANDOCERR_PF_SKIP,
1440 line, ppos, "Pf %s",
1441 p == NULL ? "at eol" : p);
1445 if (state == maxargs) {
1446 rew_elem(mdoc, tok);
1450 ntok = (tok == MDOC_Pf && state == 0) ?
1451 TOKEN_NONE : lookup(mdoc, tok, line, la, p);
1453 if (ntok != TOKEN_NONE) {
1455 rew_elem(mdoc, tok);
1458 (*mdoc_macro(ntok)->fp)(mdoc, ntok,
1459 line, la, pos, buf);
1460 if (ac == ARGS_ALLOC)
1465 if (mdoc_macro(tok)->flags & MDOC_IGNDELIM ||
1466 mdoc_isdelim(p) == DELIM_NONE) {
1468 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1470 } else if (state >= 0)
1472 } else if (state >= 0) {
1473 rew_elem(mdoc, tok);
1477 dword(mdoc, line, la, p, DELIM_MAX,
1478 mdoc_macro(tok)->flags & MDOC_JOIN);
1479 if (ac == ARGS_ALLOC)
1481 p = mdoc->last->string;
1485 mandoc_msg(MANDOCERR_MACRO_EMPTY,
1486 line, ppos, "%s", roff_name[tok]);
1490 if (state == 0 && tok == MDOC_Pf)
1491 append_delims(mdoc, line, pos, buf);
1493 rew_elem(mdoc, tok);
1495 append_delims(mdoc, line, pos, buf);
1499 in_line_eoln(MACRO_PROT_ARGS)
1501 struct roff_node *n;
1502 struct mdoc_arg *arg;
1504 if ((tok == MDOC_Pp || tok == MDOC_Lp) &&
1505 ! (mdoc->flags & MDOC_SYNOPSIS)) {
1507 if (mdoc->next == ROFF_NEXT_SIBLING)
1509 if (n->tok == MDOC_Nm)
1510 rew_last(mdoc, n->parent);
1513 if (buf[*pos] == '\0' &&
1514 (tok == MDOC_Fd || *roff_name[tok] == '%')) {
1515 mandoc_msg(MANDOCERR_MACRO_EMPTY,
1516 line, ppos, "%s", roff_name[tok]);
1520 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1521 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1522 if (parse_rest(mdoc, tok, line, pos, buf))
1524 rew_elem(mdoc, tok);
1528 * The simplest argument parser available: Parse the remaining
1529 * words until the end of the phrase or line and return 0
1530 * or until the next macro, call that macro, and return 1.
1533 parse_rest(struct roff_man *mdoc, enum roff_tok tok,
1534 int line, int *pos, char *buf)
1542 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1543 if (ac == ARGS_EOLN)
1545 done = macro_or_word(mdoc, tok, line, la, pos, buf, p, 1);
1546 if (ac == ARGS_ALLOC)
1554 ctx_synopsis(MACRO_PROT_ARGS)
1557 if (~mdoc->flags & (MDOC_SYNOPSIS | MDOC_NEWLINE))
1558 in_line(mdoc, tok, line, ppos, pos, buf);
1559 else if (tok == MDOC_Nm)
1560 blk_full(mdoc, tok, line, ppos, pos, buf);
1562 assert(tok == MDOC_Vt);
1563 blk_part_imp(mdoc, tok, line, ppos, pos, buf);
1568 * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1569 * They're unusual because they're basically free-form text until a
1570 * macro is encountered.
1573 phrase_ta(MACRO_PROT_ARGS)
1575 struct roff_node *body, *n;
1577 /* Make sure we are in a column list or ignore this macro. */
1580 for (n = mdoc->last; n != NULL; n = n->parent) {
1581 if (n->flags & NODE_ENDED)
1583 if (n->tok == MDOC_It && n->type == ROFFT_BODY)
1585 if (n->tok == MDOC_Bl && n->end == ENDBODY_NOT)
1589 if (n == NULL || n->norm->Bl.type != LIST_column) {
1590 mandoc_msg(MANDOCERR_TA_STRAY, line, ppos, "Ta");
1594 /* Advance to the next column. */
1596 rew_last(mdoc, body);
1597 roff_body_alloc(mdoc, line, ppos, MDOC_It);
1598 parse_rest(mdoc, TOKEN_NONE, line, pos, buf);