1 /* $Id: mdoc_macro.c,v 1.224 2017/05/30 16:22:03 schwarze Exp $ */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012-2017 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, 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 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 */
204 const struct mdoc_macro *const mdoc_macros = __mdoc_macros - MDOC_Dd;
208 * This is called at the end of parsing. It must traverse up the tree,
209 * closing out open [implicit] scopes. Obviously, open explicit scopes
213 mdoc_endparse(struct roff_man *mdoc)
217 /* Scan for open explicit scopes. */
219 n = mdoc->last->flags & NODE_VALID ?
220 mdoc->last->parent : mdoc->last;
222 for ( ; n; n = n->parent)
223 if (n->type == ROFFT_BLOCK &&
224 mdoc_macros[n->tok].flags & MDOC_EXPLICIT)
225 mandoc_msg(MANDOCERR_BLK_NOEND, mdoc->parse,
226 n->line, n->pos, roff_name[n->tok]);
228 /* Rewind to the first. */
230 rew_last(mdoc, mdoc->first);
231 mdoc_state_reset(mdoc);
235 * Look up the macro at *p called by "from",
236 * or as a line macro if from == TOKEN_NONE.
239 lookup(struct roff_man *mdoc, int from, int line, int ppos, const char *p)
243 if (mdoc->flags & MDOC_PHRASEQF) {
244 mdoc->flags &= ~MDOC_PHRASEQF;
247 if (from == TOKEN_NONE || mdoc_macros[from].flags & MDOC_PARSED) {
248 res = roffhash_find(mdoc->mdocmac, p, 0);
249 if (res != TOKEN_NONE) {
250 if (mdoc_macros[res].flags & MDOC_CALLABLE)
252 mandoc_msg(MANDOCERR_MACRO_CALL,
253 mdoc->parse, line, ppos, p);
260 * Rewind up to and including a specific node.
263 rew_last(struct roff_man *mdoc, const struct roff_node *to)
266 if (to->flags & NODE_VALID)
269 while (mdoc->last != to) {
270 mdoc_state(mdoc, mdoc->last);
271 mdoc->last->flags |= NODE_VALID | NODE_ENDED;
272 mdoc->last = mdoc->last->parent;
274 mdoc_state(mdoc, mdoc->last);
275 mdoc->last->flags |= NODE_VALID | NODE_ENDED;
276 mdoc->next = ROFF_NEXT_SIBLING;
280 * Rewind up to a specific block, including all blocks that broke it.
283 rew_pending(struct roff_man *mdoc, const struct roff_node *n)
289 if (mdoc->last == n) {
292 roff_body_alloc(mdoc, n->line, n->pos,
300 if ( ! (n->flags & NODE_BROKEN))
306 if ((n = n->parent) == NULL)
309 if (n->type == ROFFT_BLOCK ||
310 n->type == ROFFT_HEAD) {
311 if (n->flags & NODE_ENDED)
321 * For a block closing macro, return the corresponding opening one.
322 * Otherwise, return the macro itself.
325 rew_alt(enum roff_tok tok)
366 rew_elem(struct roff_man *mdoc, enum roff_tok tok)
371 if (n->type != ROFFT_ELEM)
373 assert(n->type == ROFFT_ELEM);
374 assert(tok == n->tok);
379 break_intermediate(struct roff_node *n, struct roff_node *breaker)
382 n->type != ROFFT_BLOCK && n->type != ROFFT_HEAD &&
383 (n->type != ROFFT_BODY || n->end != ENDBODY_NOT))
385 while (n != breaker) {
386 if ( ! (n->flags & NODE_VALID))
387 n->flags |= NODE_BROKEN;
393 * If there is an open sub-block of the target requiring
394 * explicit close-out, postpone closing out the target until
395 * the rew_pending() call closing out the sub-block.
398 find_pending(struct roff_man *mdoc, enum roff_tok tok, int line, int ppos,
399 struct roff_node *target)
404 if (target->flags & NODE_VALID)
408 for (n = mdoc->last; n != NULL && n != target; n = n->parent) {
409 if (n->flags & NODE_ENDED)
411 if (n->type == ROFFT_BLOCK &&
412 mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
414 break_intermediate(mdoc->last, target);
415 if (target->type == ROFFT_HEAD)
416 target->flags |= NODE_ENDED;
417 else if ( ! (target->flags & NODE_ENDED)) {
418 mandoc_vmsg(MANDOCERR_BLK_NEST,
419 mdoc->parse, line, ppos,
420 "%s breaks %s", roff_name[tok],
422 mdoc_endbody_alloc(mdoc, line, ppos,
431 * Allocate a word and check whether it's punctuation or not.
432 * Punctuation consists of those tokens found in mdoc_isdelim().
435 dword(struct roff_man *mdoc, int line, int col, const char *p,
436 enum mdelim d, int may_append)
443 ! (mdoc->flags & (MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF)) &&
444 d == DELIM_NONE && mdoc->last->type == ROFFT_TEXT &&
445 mdoc_isdelim(mdoc->last->string) == DELIM_NONE) {
446 roff_word_append(mdoc, p);
450 roff_word_alloc(mdoc, line, col, p);
453 * If the word consists of a bare delimiter,
454 * flag the new node accordingly,
455 * unless doing so was vetoed by the invoking macro.
456 * Always clear the veto, it is only valid for one word.
460 mdoc->last->flags |= NODE_DELIMO;
461 else if (d == DELIM_CLOSE &&
462 ! (mdoc->flags & MDOC_NODELIMC) &&
463 mdoc->last->parent->tok != MDOC_Fd)
464 mdoc->last->flags |= NODE_DELIMC;
465 mdoc->flags &= ~MDOC_NODELIMC;
469 append_delims(struct roff_man *mdoc, int line, int *pos, char *buf)
474 if (buf[*pos] == '\0')
479 if (mdoc_args(mdoc, line, pos, buf, TOKEN_NONE, &p) ==
482 dword(mdoc, line, la, p, DELIM_MAX, 1);
485 * If we encounter end-of-sentence symbols, then trigger
488 * XXX: it's easy to allow this to propagate outward to
489 * the last symbol, such that `. )' will cause the
490 * correct double-spacing. However, (1) groff isn't
491 * smart enough to do this and (2) it would require
492 * knowing which symbols break this behaviour, for
493 * example, `. ;' shouldn't propagate the double-space.
496 if (mandoc_eos(p, strlen(p)))
497 mdoc->last->flags |= NODE_EOS;
503 * If it is a macro, call it and return 1.
504 * Otherwise, allocate it and return 0.
507 macro_or_word(MACRO_PROT_ARGS, int parsed)
516 else if (parsed && ! (mdoc->flags & MDOC_PHRASELIT))
517 ntok = lookup(mdoc, tok, line, ppos, p);
519 if (ntok == TOKEN_NONE) {
520 dword(mdoc, line, ppos, p, DELIM_MAX, tok == TOKEN_NONE ||
521 mdoc_macros[tok].flags & MDOC_JOIN);
524 if (tok != TOKEN_NONE &&
525 mdoc_macros[tok].fp == in_line_eoln)
527 mdoc_macro(mdoc, ntok, line, ppos, pos, buf);
528 if (tok == TOKEN_NONE)
529 append_delims(mdoc, line, pos, buf);
535 * Close out block partial/full explicit.
538 blk_exp_close(MACRO_PROT_ARGS)
540 struct roff_node *body; /* Our own body. */
541 struct roff_node *endbody; /* Our own end marker. */
542 struct roff_node *itblk; /* An It block starting later. */
543 struct roff_node *later; /* A sub-block starting later. */
544 struct roff_node *n; /* Search back to our block. */
545 struct roff_node *target; /* For find_pending(). */
547 int j, lastarg, maxargs, nl, pending;
549 enum roff_tok atok, ntok;
552 nl = MDOC_NEWLINE & mdoc->flags;
559 mdoc->flags &= ~MDOC_KEEP;
566 /* Search backwards for the beginning of our own body. */
570 for (n = mdoc->last; n; n = n->parent) {
571 if (n->flags & NODE_ENDED || n->tok != atok ||
572 n->type != ROFFT_BODY || n->end != ENDBODY_NOT)
579 * Search backwards for beginnings of blocks,
580 * both of our own and of pending sub-blocks.
583 endbody = itblk = later = NULL;
584 for (n = mdoc->last; n; n = n->parent) {
585 if (n->flags & NODE_ENDED)
589 * Mismatching end macros can never break anything
590 * and we only care about the breaking of BLOCKs.
593 if (body == NULL || n->type != ROFFT_BLOCK)
597 * SYNOPSIS name blocks can not be broken themselves,
598 * but they do get broken together with a broken child.
601 if (n->tok == MDOC_Nm) {
603 n->flags |= NODE_BROKEN | NODE_ENDED;
607 if (n->tok == MDOC_It) {
612 if (atok == n->tok) {
615 * Found the start of our own block.
616 * When there is no pending sub block,
617 * just proceed to closing out.
621 (tok == MDOC_El && itblk == NULL))
625 * When there is a pending sub block, postpone
626 * closing out the current block until the
627 * rew_pending() closing out the sub-block.
628 * Mark the place where the formatting - but not
629 * the scope - of the current block ends.
632 mandoc_vmsg(MANDOCERR_BLK_NEST, mdoc->parse,
633 line, ppos, "%s breaks %s",
634 roff_name[atok], roff_name[later->tok]);
636 endbody = mdoc_endbody_alloc(mdoc, line, ppos,
640 itblk->flags |= NODE_ENDED | NODE_BROKEN;
643 * If a block closing macro taking arguments
644 * breaks another block, put the arguments
645 * into the end marker.
649 mdoc->next = ROFF_NEXT_CHILD;
654 * Explicit blocks close out description lines, but
655 * even those can get broken together with a child.
658 if (n->tok == MDOC_Nd) {
660 n->flags |= NODE_BROKEN | NODE_ENDED;
666 /* Breaking an open sub block. */
668 break_intermediate(mdoc->last, body);
669 n->flags |= NODE_BROKEN;
675 mandoc_msg(MANDOCERR_BLK_NOTOPEN, mdoc->parse,
676 line, ppos, roff_name[tok]);
677 if (maxargs && endbody == NULL) {
679 * Stray .Ec without previous .Eo:
680 * Break the output line, keep the arguments.
682 roff_elem_alloc(mdoc, line, ppos, ROFF_br);
683 rew_elem(mdoc, ROFF_br);
685 } else if (endbody == NULL) {
686 rew_last(mdoc, body);
688 mdoc_tail_alloc(mdoc, line, ppos, atok);
691 if ( ! (mdoc_macros[tok].flags & MDOC_PARSED)) {
692 if (buf[*pos] != '\0')
693 mandoc_vmsg(MANDOCERR_ARG_SKIP,
694 mdoc->parse, line, ppos,
695 "%s %s", roff_name[tok],
697 if (endbody == NULL && n != NULL)
698 rew_pending(mdoc, n);
709 if (j == maxargs && n != NULL)
712 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
713 if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
716 ntok = lookup(mdoc, tok, line, lastarg, p);
718 if (ntok == TOKEN_NONE) {
719 dword(mdoc, line, lastarg, p, DELIM_MAX,
720 MDOC_JOIN & mdoc_macros[tok].flags);
726 mdoc->flags &= ~MDOC_NEWLINE;
727 mdoc_macro(mdoc, ntok, line, lastarg, pos, buf);
733 if (ntok != TOKEN_NONE && n->flags & NODE_BROKEN) {
736 target = target->parent;
737 while ( ! (target->flags & NODE_ENDED));
738 pending = find_pending(mdoc, ntok, line, ppos, target);
741 rew_pending(mdoc, n);
744 append_delims(mdoc, line, pos, buf);
748 in_line(MACRO_PROT_ARGS)
750 int la, scope, cnt, firstarg, mayopen, nc, nl;
754 struct mdoc_arg *arg;
757 nl = MDOC_NEWLINE & mdoc->flags;
760 * Whether we allow ignored elements (those without content,
761 * usually because of reserved words) to squeak by.
778 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
783 for (cnt = scope = 0;; ) {
785 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
788 * At the end of a macro line,
789 * opening delimiters do not suppress spacing.
792 if (ac == ARGS_EOLN) {
794 mdoc->last->flags &= ~NODE_DELIMO;
799 * The rest of the macro line is only punctuation,
800 * to be handled by append_delims().
801 * If there were no other arguments,
802 * do not allow the first one to suppress spacing,
803 * even if it turns out to be a closing one.
806 if (ac == ARGS_PUNCT) {
807 if (cnt == 0 && (nc == 0 || tok == MDOC_An))
808 mdoc->flags |= MDOC_NODELIMC;
812 ntok = (tok == MDOC_Fn && !cnt) ?
813 TOKEN_NONE : lookup(mdoc, tok, line, la, p);
816 * In this case, we've located a submacro and must
817 * execute it. Close out scope, if open. If no
818 * elements have been generated, either create one (nc)
819 * or raise a warning.
822 if (ntok != TOKEN_NONE) {
826 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
827 rew_last(mdoc, mdoc->last);
828 } else if ( ! nc && ! cnt) {
830 mandoc_msg(MANDOCERR_MACRO_EMPTY,
831 mdoc->parse, line, ppos,
834 mdoc_macro(mdoc, ntok, line, la, pos, buf);
836 append_delims(mdoc, line, pos, buf);
841 * Handle punctuation. Set up our scope, if a word;
842 * rewind the scope, if a delimiter; then append the word.
845 if ((d = mdoc_isdelim(p)) != DELIM_NONE) {
847 * If we encounter closing punctuation, no word
848 * has been emitted, no scope is open, and we're
849 * allowed to have an empty element, then start
852 if ((d == DELIM_CLOSE ||
853 (d == DELIM_MIDDLE && tok == MDOC_Fl)) &&
854 !cnt && !scope && nc && mayopen) {
855 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
862 * Close out our scope, if one is open, before
865 if (scope && tok != MDOC_Lk) {
871 } else if (mayopen && !scope) {
872 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
877 dword(mdoc, line, la, p, d,
878 mdoc_macros[tok].flags & MDOC_JOIN);
881 * If the first argument is a closing delimiter,
882 * do not suppress spacing before it.
885 if (firstarg && d == DELIM_CLOSE && !nc)
886 mdoc->last->flags &= ~NODE_DELIMC;
890 * `Fl' macros have their scope re-opened with each new
891 * word so that the `-' can be added to each one without
892 * having to parse out spaces.
894 if (scope && tok == MDOC_Fl) {
900 if (scope && tok != MDOC_Lk) {
906 * If no elements have been collected and we're allowed to have
907 * empties (nc), open a scope and close it out. Otherwise,
913 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
914 rew_last(mdoc, mdoc->last);
917 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
918 line, ppos, roff_name[tok]);
922 append_delims(mdoc, line, pos, buf);
928 blk_full(MACRO_PROT_ARGS)
931 struct mdoc_arg *arg;
932 struct roff_node *blk; /* Our own or a broken block. */
933 struct roff_node *head; /* Our own head. */
934 struct roff_node *body; /* Our own body. */
936 enum margserr ac, lac;
939 nl = MDOC_NEWLINE & mdoc->flags;
941 if (buf[*pos] == '\0' && (tok == MDOC_Sh || tok == MDOC_Ss)) {
942 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
943 line, ppos, roff_name[tok]);
947 if ( ! (mdoc_macros[tok].flags & MDOC_EXPLICIT)) {
949 /* Here, tok is one of Sh Ss Nm Nd It. */
952 for (n = mdoc->last; n != NULL; n = n->parent) {
953 if (n->flags & NODE_ENDED) {
954 if ( ! (n->flags & NODE_VALID))
955 n->flags |= NODE_BROKEN;
958 if (n->type != ROFFT_BLOCK)
961 if (tok == MDOC_It && n->tok == MDOC_Bl) {
963 mandoc_vmsg(MANDOCERR_BLK_BROKEN,
964 mdoc->parse, line, ppos,
966 roff_name[blk->tok]);
967 rew_pending(mdoc, blk);
972 if (mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
976 mandoc_vmsg(MANDOCERR_BLK_BROKEN,
977 mdoc->parse, line, ppos,
978 "%s breaks %s", roff_name[tok],
980 rew_pending(mdoc, n);
984 /* Delay in case it's astray. */
993 /* Here, n is one of Sh Ss Nm Nd It. */
995 if (tok != MDOC_Sh && (n->tok == MDOC_Sh ||
996 (tok != MDOC_Ss && (n->tok == MDOC_Ss ||
997 (tok != MDOC_It && n->tok == MDOC_It)))))
1000 /* Item breaking an explicit block. */
1003 mandoc_vmsg(MANDOCERR_BLK_BROKEN,
1004 mdoc->parse, line, ppos,
1005 "It breaks %s", roff_name[blk->tok]);
1006 rew_pending(mdoc, blk);
1010 /* Close out prior implicit scopes. */
1012 rew_pending(mdoc, n);
1015 /* Skip items outside lists. */
1017 if (tok == MDOC_It && (n == NULL || n->tok != MDOC_Bl)) {
1018 mandoc_vmsg(MANDOCERR_IT_STRAY, mdoc->parse,
1019 line, ppos, "It %s", buf + *pos);
1020 roff_elem_alloc(mdoc, line, ppos, ROFF_br);
1021 rew_elem(mdoc, ROFF_br);
1027 * This routine accommodates implicitly- and explicitly-scoped
1028 * macro openings. Implicit ones first close out prior scope
1029 * (seen above). Delay opening the head until necessary to
1030 * allow leading punctuation to print. Special consideration
1031 * for `It -column', which has phrase-part syntax instead of
1032 * regular child nodes.
1035 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1036 blk = mdoc_block_alloc(mdoc, line, ppos, tok, arg);
1040 * Exception: Heads of `It' macros in `-diag' lists are not
1041 * parsed, even though `It' macros in general are parsed.
1044 parsed = tok != MDOC_It ||
1045 mdoc->last->parent->tok != MDOC_Bl ||
1046 mdoc->last->parent->norm->Bl.type != LIST_diag;
1049 * The `Nd' macro has all arguments in its body: it's a hybrid
1050 * of block partial-explicit and full-implicit. Stupid.
1053 if (tok == MDOC_Nd) {
1054 head = roff_head_alloc(mdoc, line, ppos, tok);
1055 rew_last(mdoc, head);
1056 body = roff_body_alloc(mdoc, line, ppos, tok);
1060 mdoc->flags |= MDOC_KEEP;
1066 * If we are right after a tab character,
1067 * do not parse the first word for macros.
1070 if (mdoc->flags & MDOC_PHRASEQN) {
1071 mdoc->flags &= ~MDOC_PHRASEQN;
1072 mdoc->flags |= MDOC_PHRASEQF;
1077 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1078 if (ac == ARGS_EOLN) {
1079 if (lac != ARGS_PHRASE ||
1080 ! (mdoc->flags & MDOC_PHRASEQF))
1084 * This line ends in a tab; start the next
1085 * column now, with a leading blank.
1089 rew_last(mdoc, body);
1090 body = roff_body_alloc(mdoc, line, ppos, tok);
1091 roff_word_alloc(mdoc, line, ppos, "\\&");
1095 if (tok == MDOC_Bd || tok == MDOC_Bk) {
1096 mandoc_vmsg(MANDOCERR_ARG_EXCESS,
1097 mdoc->parse, line, la, "%s ... %s",
1098 roff_name[tok], buf + la);
1101 if (tok == MDOC_Rs) {
1102 mandoc_vmsg(MANDOCERR_ARG_SKIP, mdoc->parse,
1103 line, la, "Rs %s", buf + la);
1106 if (ac == ARGS_PUNCT)
1110 * Emit leading punctuation (i.e., punctuation before
1111 * the ROFFT_HEAD) for non-phrase types.
1115 ac != ARGS_PHRASE &&
1116 mdoc_isdelim(p) == DELIM_OPEN) {
1117 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1121 /* Open a head if one hasn't been opened. */
1124 head = roff_head_alloc(mdoc, line, ppos, tok);
1126 if (ac == ARGS_PHRASE) {
1129 * If we haven't opened a body yet, rewind the
1130 * head; if we have, rewind that instead.
1133 rew_last(mdoc, body == NULL ? head : body);
1134 body = roff_body_alloc(mdoc, line, ppos, tok);
1136 /* Process to the tab or to the end of the line. */
1138 mdoc->flags |= MDOC_PHRASE;
1139 parse_rest(mdoc, TOKEN_NONE, line, &la, buf);
1140 mdoc->flags &= ~MDOC_PHRASE;
1142 /* There may have been `Ta' macros. */
1144 while (body->next != NULL)
1149 if (macro_or_word(mdoc, tok, line, la, pos, buf, parsed))
1153 if (blk->flags & NODE_VALID)
1156 head = roff_head_alloc(mdoc, line, ppos, tok);
1157 if (nl && tok != MDOC_Bd && tok != MDOC_Bl && tok != MDOC_Rs)
1158 append_delims(mdoc, line, pos, buf);
1161 if (find_pending(mdoc, tok, line, ppos, head))
1164 /* Close out scopes to remain in a consistent state. */
1166 rew_last(mdoc, head);
1167 body = roff_body_alloc(mdoc, line, ppos, tok);
1169 if (mdoc->flags & MDOC_FREECOL) {
1170 rew_last(mdoc, body);
1171 rew_last(mdoc, blk);
1172 mdoc->flags &= ~MDOC_FREECOL;
1177 blk_part_imp(MACRO_PROT_ARGS)
1182 struct roff_node *blk; /* saved block context */
1183 struct roff_node *body; /* saved body context */
1184 struct roff_node *n;
1186 nl = MDOC_NEWLINE & mdoc->flags;
1189 * A macro that spans to the end of the line. This is generally
1190 * (but not necessarily) called as the first macro. The block
1191 * has a head as the immediate child, which is always empty,
1192 * followed by zero or more opening punctuation nodes, then the
1193 * body (which may be empty, depending on the macro), then zero
1194 * or more closing punctuation nodes.
1197 blk = mdoc_block_alloc(mdoc, line, ppos, tok, NULL);
1198 rew_last(mdoc, roff_head_alloc(mdoc, line, ppos, tok));
1201 * Open the body scope "on-demand", that is, after we've
1202 * processed all our the leading delimiters (open parenthesis,
1206 for (body = NULL; ; ) {
1208 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1209 if (ac == ARGS_EOLN || ac == ARGS_PUNCT)
1212 if (body == NULL && mdoc_isdelim(p) == DELIM_OPEN) {
1213 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1218 body = roff_body_alloc(mdoc, line, ppos, tok);
1220 if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1224 body = roff_body_alloc(mdoc, line, ppos, tok);
1226 if (find_pending(mdoc, tok, line, ppos, body))
1229 rew_last(mdoc, body);
1231 append_delims(mdoc, line, pos, buf);
1232 rew_pending(mdoc, blk);
1234 /* Move trailing .Ns out of scope. */
1236 for (n = body->child; n && n->next; n = n->next)
1238 if (n && n->tok == MDOC_Ns)
1239 mdoc_node_relink(mdoc, n);
1243 blk_part_exp(MACRO_PROT_ARGS)
1247 struct roff_node *head; /* keep track of head */
1250 nl = MDOC_NEWLINE & mdoc->flags;
1253 * The opening of an explicit macro having zero or more leading
1254 * punctuation nodes; a head with optional single element (the
1255 * case of `Eo'); and a body that may be empty.
1258 roff_block_alloc(mdoc, line, ppos, tok);
1262 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1263 if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
1266 /* Flush out leading punctuation. */
1268 if (head == NULL && mdoc_isdelim(p) == DELIM_OPEN) {
1269 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1274 head = roff_head_alloc(mdoc, line, ppos, tok);
1275 if (tok == MDOC_Eo) /* Not parsed. */
1276 dword(mdoc, line, la, p, DELIM_MAX, 0);
1277 rew_last(mdoc, head);
1278 roff_body_alloc(mdoc, line, ppos, tok);
1283 if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1287 /* Clean-up to leave in a consistent state. */
1290 rew_last(mdoc, roff_head_alloc(mdoc, line, ppos, tok));
1291 roff_body_alloc(mdoc, line, ppos, tok);
1294 append_delims(mdoc, line, pos, buf);
1298 in_line_argn(MACRO_PROT_ARGS)
1300 struct mdoc_arg *arg;
1304 int state; /* arg#; -1: not yet open; -2: closed */
1305 int la, maxargs, nl;
1307 nl = mdoc->flags & MDOC_NEWLINE;
1310 * A line macro that has a fixed number of arguments (maxargs).
1311 * Only open the scope once the first non-leading-punctuation is
1312 * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1313 * keep it open until the maximum number of arguments are
1333 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1339 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1341 if (ac == ARGS_WORD && state == -1 &&
1342 ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) &&
1343 mdoc_isdelim(p) == DELIM_OPEN) {
1344 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1348 if (state == -1 && tok != MDOC_In &&
1349 tok != MDOC_St && tok != MDOC_Xr) {
1350 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1354 if (ac == ARGS_PUNCT || ac == ARGS_EOLN) {
1355 if (abs(state) < 2 && tok == MDOC_Pf)
1356 mandoc_vmsg(MANDOCERR_PF_SKIP,
1357 mdoc->parse, line, ppos, "Pf %s",
1358 p == NULL ? "at eol" : p);
1362 if (state == maxargs) {
1363 rew_elem(mdoc, tok);
1367 ntok = (tok == MDOC_Pf && state == 0) ?
1368 TOKEN_NONE : lookup(mdoc, tok, line, la, p);
1370 if (ntok != TOKEN_NONE) {
1372 rew_elem(mdoc, tok);
1375 mdoc_macro(mdoc, ntok, line, la, pos, buf);
1379 if (mdoc_macros[tok].flags & MDOC_IGNDELIM ||
1380 mdoc_isdelim(p) == DELIM_NONE) {
1382 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1384 } else if (state >= 0)
1386 } else if (state >= 0) {
1387 rew_elem(mdoc, tok);
1391 dword(mdoc, line, la, p, DELIM_MAX,
1392 mdoc_macros[tok].flags & MDOC_JOIN);
1396 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
1397 line, ppos, roff_name[tok]);
1401 if (state == 0 && tok == MDOC_Pf)
1402 append_delims(mdoc, line, pos, buf);
1404 rew_elem(mdoc, tok);
1406 append_delims(mdoc, line, pos, buf);
1410 in_line_eoln(MACRO_PROT_ARGS)
1412 struct roff_node *n;
1413 struct mdoc_arg *arg;
1415 if ((tok == MDOC_Pp || tok == MDOC_Lp) &&
1416 ! (mdoc->flags & MDOC_SYNOPSIS)) {
1418 if (mdoc->next == ROFF_NEXT_SIBLING)
1420 if (n->tok == MDOC_Nm)
1421 rew_last(mdoc, n->parent);
1424 if (buf[*pos] == '\0' &&
1425 (tok == MDOC_Fd || *roff_name[tok] == '%')) {
1426 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
1427 line, ppos, roff_name[tok]);
1431 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1432 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1433 if (parse_rest(mdoc, tok, line, pos, buf))
1435 rew_elem(mdoc, tok);
1439 * The simplest argument parser available: Parse the remaining
1440 * words until the end of the phrase or line and return 0
1441 * or until the next macro, call that macro, and return 1.
1444 parse_rest(struct roff_man *mdoc, enum roff_tok tok,
1445 int line, int *pos, char *buf)
1451 if (mdoc_args(mdoc, line, pos, buf, tok, NULL) == ARGS_EOLN)
1453 if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1459 ctx_synopsis(MACRO_PROT_ARGS)
1462 if (~mdoc->flags & (MDOC_SYNOPSIS | MDOC_NEWLINE))
1463 in_line(mdoc, tok, line, ppos, pos, buf);
1464 else if (tok == MDOC_Nm)
1465 blk_full(mdoc, tok, line, ppos, pos, buf);
1467 assert(tok == MDOC_Vt);
1468 blk_part_imp(mdoc, tok, line, ppos, pos, buf);
1473 * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1474 * They're unusual because they're basically free-form text until a
1475 * macro is encountered.
1478 phrase_ta(MACRO_PROT_ARGS)
1480 struct roff_node *body, *n;
1482 /* Make sure we are in a column list or ignore this macro. */
1485 for (n = mdoc->last; n != NULL; n = n->parent) {
1486 if (n->flags & NODE_ENDED)
1488 if (n->tok == MDOC_It && n->type == ROFFT_BODY)
1490 if (n->tok == MDOC_Bl && n->end == ENDBODY_NOT)
1494 if (n == NULL || n->norm->Bl.type != LIST_column) {
1495 mandoc_msg(MANDOCERR_TA_STRAY, mdoc->parse,
1500 /* Advance to the next column. */
1502 rew_last(mdoc, body);
1503 roff_body_alloc(mdoc, line, ppos, MDOC_It);
1504 parse_rest(mdoc, TOKEN_NONE, line, pos, buf);