]> git.cameronkatri.com Git - mandoc.git/blob - mdoc_macro.c
git.ckatri.com / mandoc.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Parser unification: use nice ohashes for all three request and macro tables;
[mandoc.git] / mdoc_macro.c
1 /* $Id: mdoc_macro.c,v 1.220 2017/04/29 12:45:42 schwarze Exp $ */
2 /*
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012-2017 Ingo Schwarze <schwarze@openbsd.org>
5 *
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.
9 *
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.
17 */
18 #include "config.h"
19
20 #include <sys/types.h>
21
22 #include <assert.h>
23 #include <ctype.h>
24 #include <stdlib.h>
25 #include <stdio.h>
26 #include <string.h>
27 #include <time.h>
28
29 #include "mandoc.h"
30 #include "roff.h"
31 #include "mdoc.h"
32 #include "libmandoc.h"
33 #include "roff_int.h"
34 #include "libmdoc.h"
35
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);
45
46 static void append_delims(struct roff_man *, int, int *, char *);
47 static void dword(struct roff_man *, int, int, const char *,
48 enum mdelim, int);
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 *,
54 struct roff_node *);
55 static int parse_rest(struct roff_man *, enum roff_tok,
56 int, int *, char *);
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 *);
62
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 | MDOC_JOIN }, /* Ap */
80 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
81 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Cd */
82 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
83 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
84 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
85 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
86 { in_line_eoln, 0 }, /* Ex */
87 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */
88 { in_line_eoln, 0 }, /* Fd */
89 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
90 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */
91 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */
92 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ic */
93 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */
94 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Li */
95 { blk_full, MDOC_JOIN }, /* Nd */
96 { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
97 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
98 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ot */
99 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
100 { in_line_eoln, 0 }, /* Rv */
101 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */
102 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
103 { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
104 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
105 { in_line_eoln, MDOC_JOIN }, /* %A */
106 { in_line_eoln, MDOC_JOIN }, /* %B */
107 { in_line_eoln, MDOC_JOIN }, /* %D */
108 { in_line_eoln, MDOC_JOIN }, /* %I */
109 { in_line_eoln, MDOC_JOIN }, /* %J */
110 { in_line_eoln, 0 }, /* %N */
111 { in_line_eoln, MDOC_JOIN }, /* %O */
112 { in_line_eoln, 0 }, /* %P */
113 { in_line_eoln, MDOC_JOIN }, /* %R */
114 { in_line_eoln, MDOC_JOIN }, /* %T */
115 { in_line_eoln, 0 }, /* %V */
116 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
117 MDOC_EXPLICIT | MDOC_JOIN }, /* Ac */
118 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
119 MDOC_EXPLICIT | MDOC_JOIN }, /* Ao */
120 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Aq */
121 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* At */
122 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
123 MDOC_EXPLICIT | MDOC_JOIN }, /* Bc */
124 { blk_full, MDOC_EXPLICIT }, /* Bf */
125 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
126 MDOC_EXPLICIT | MDOC_JOIN }, /* Bo */
127 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Bq */
128 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */
129 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */
130 { in_line_eoln, 0 }, /* Db */
131 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
132 MDOC_EXPLICIT | MDOC_JOIN }, /* Dc */
133 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
134 MDOC_EXPLICIT | MDOC_JOIN }, /* Do */
135 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Dq */
136 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ec */
137 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ef */
138 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Em */
139 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
140 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */
141 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */
142 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* No */
143 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED |
144 MDOC_IGNDELIM | MDOC_JOIN }, /* Ns */
145 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
146 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
147 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
148 MDOC_EXPLICIT | MDOC_JOIN }, /* Pc */
149 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
150 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
151 MDOC_EXPLICIT | MDOC_JOIN }, /* Po */
152 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Pq */
153 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
154 MDOC_EXPLICIT | MDOC_JOIN }, /* Qc */
155 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ql */
156 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
157 MDOC_EXPLICIT | MDOC_JOIN }, /* Qo */
158 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Qq */
159 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Re */
160 { blk_full, MDOC_EXPLICIT }, /* Rs */
161 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
162 MDOC_EXPLICIT | MDOC_JOIN }, /* Sc */
163 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
164 MDOC_EXPLICIT | MDOC_JOIN }, /* So */
165 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sq */
166 { in_line_argn, 0 }, /* Sm */
167 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sx */
168 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sy */
169 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
170 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ux */
171 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
172 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
173 { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
174 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
175 MDOC_EXPLICIT | MDOC_JOIN }, /* Fc */
176 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
177 MDOC_EXPLICIT | MDOC_JOIN }, /* Oo */
178 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
179 MDOC_EXPLICIT | MDOC_JOIN }, /* Oc */
180 { blk_full, MDOC_EXPLICIT }, /* Bk */
181 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ek */
182 { in_line_eoln, 0 }, /* Bt */
183 { in_line_eoln, 0 }, /* Hf */
184 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fr */
185 { in_line_eoln, 0 }, /* Ud */
186 { in_line, 0 }, /* Lb */
187 { in_line_eoln, 0 }, /* Lp */
188 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
189 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
190 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Brq */
191 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
192 MDOC_EXPLICIT | MDOC_JOIN }, /* Bro */
193 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
194 MDOC_EXPLICIT | MDOC_JOIN }, /* Brc */
195 { in_line_eoln, MDOC_JOIN }, /* %C */
196 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Es */
197 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* En */
198 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
199 { in_line_eoln, MDOC_JOIN }, /* %Q */
200 { in_line_eoln, 0 }, /* br */
201 { in_line_eoln, 0 }, /* sp */
202 { in_line_eoln, 0 }, /* %U */
203 { phrase_ta, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ta */
204 { in_line_eoln, MDOC_PROLOGUE }, /* ll */
205 };
206 const struct mdoc_macro *const mdoc_macros = __mdoc_macros - MDOC_Dd;
207
208
209 /*
210 * This is called at the end of parsing. It must traverse up the tree,
211 * closing out open [implicit] scopes. Obviously, open explicit scopes
212 * are errors.
213 */
214 void
215 mdoc_endparse(struct roff_man *mdoc)
216 {
217 struct roff_node *n;
218
219 /* Scan for open explicit scopes. */
220
221 n = mdoc->last->flags & NODE_VALID ?
222 mdoc->last->parent : mdoc->last;
223
224 for ( ; n; n = n->parent)
225 if (n->type == ROFFT_BLOCK &&
226 mdoc_macros[n->tok].flags & MDOC_EXPLICIT)
227 mandoc_msg(MANDOCERR_BLK_NOEND, mdoc->parse,
228 n->line, n->pos, roff_name[n->tok]);
229
230 /* Rewind to the first. */
231
232 rew_last(mdoc, mdoc->first);
233 mdoc_state_reset(mdoc);
234 }
235
236 /*
237 * Look up the macro at *p called by "from",
238 * or as a line macro if from == TOKEN_NONE.
239 */
240 static int
241 lookup(struct roff_man *mdoc, int from, int line, int ppos, const char *p)
242 {
243 enum roff_tok res;
244
245 if (mdoc->flags & MDOC_PHRASEQF) {
246 mdoc->flags &= ~MDOC_PHRASEQF;
247 return TOKEN_NONE;
248 }
249 if (from == TOKEN_NONE || mdoc_macros[from].flags & MDOC_PARSED) {
250 res = roffhash_find(mdoc->mdocmac, p, 0);
251 if (res != TOKEN_NONE) {
252 if (mdoc_macros[res].flags & MDOC_CALLABLE)
253 return res;
254 if (res != MDOC_br && res != MDOC_sp && res != MDOC_ll)
255 mandoc_msg(MANDOCERR_MACRO_CALL,
256 mdoc->parse, line, ppos, p);
257 }
258 }
259 return TOKEN_NONE;
260 }
261
262 /*
263 * Rewind up to and including a specific node.
264 */
265 static void
266 rew_last(struct roff_man *mdoc, const struct roff_node *to)
267 {
268
269 if (to->flags & NODE_VALID)
270 return;
271
272 while (mdoc->last != to) {
273 mdoc_state(mdoc, mdoc->last);
274 mdoc->last->flags |= NODE_VALID | NODE_ENDED;
275 mdoc->last = mdoc->last->parent;
276 }
277 mdoc_state(mdoc, mdoc->last);
278 mdoc->last->flags |= NODE_VALID | NODE_ENDED;
279 mdoc->next = ROFF_NEXT_SIBLING;
280 }
281
282 /*
283 * Rewind up to a specific block, including all blocks that broke it.
284 */
285 static void
286 rew_pending(struct roff_man *mdoc, const struct roff_node *n)
287 {
288
289 for (;;) {
290 rew_last(mdoc, n);
291
292 if (mdoc->last == n) {
293 switch (n->type) {
294 case ROFFT_HEAD:
295 roff_body_alloc(mdoc, n->line, n->pos,
296 n->tok);
297 break;
298 case ROFFT_BLOCK:
299 break;
300 default:
301 return;
302 }
303 if ( ! (n->flags & NODE_BROKEN))
304 return;
305 } else
306 n = mdoc->last;
307
308 for (;;) {
309 if ((n = n->parent) == NULL)
310 return;
311
312 if (n->type == ROFFT_BLOCK ||
313 n->type == ROFFT_HEAD) {
314 if (n->flags & NODE_ENDED)
315 break;
316 else
317 return;
318 }
319 }
320 }
321 }
322
323 /*
324 * For a block closing macro, return the corresponding opening one.
325 * Otherwise, return the macro itself.
326 */
327 static enum roff_tok
328 rew_alt(enum roff_tok tok)
329 {
330 switch (tok) {
331 case MDOC_Ac:
332 return MDOC_Ao;
333 case MDOC_Bc:
334 return MDOC_Bo;
335 case MDOC_Brc:
336 return MDOC_Bro;
337 case MDOC_Dc:
338 return MDOC_Do;
339 case MDOC_Ec:
340 return MDOC_Eo;
341 case MDOC_Ed:
342 return MDOC_Bd;
343 case MDOC_Ef:
344 return MDOC_Bf;
345 case MDOC_Ek:
346 return MDOC_Bk;
347 case MDOC_El:
348 return MDOC_Bl;
349 case MDOC_Fc:
350 return MDOC_Fo;
351 case MDOC_Oc:
352 return MDOC_Oo;
353 case MDOC_Pc:
354 return MDOC_Po;
355 case MDOC_Qc:
356 return MDOC_Qo;
357 case MDOC_Re:
358 return MDOC_Rs;
359 case MDOC_Sc:
360 return MDOC_So;
361 case MDOC_Xc:
362 return MDOC_Xo;
363 default:
364 return tok;
365 }
366 }
367
368 static void
369 rew_elem(struct roff_man *mdoc, enum roff_tok tok)
370 {
371 struct roff_node *n;
372
373 n = mdoc->last;
374 if (n->type != ROFFT_ELEM)
375 n = n->parent;
376 assert(n->type == ROFFT_ELEM);
377 assert(tok == n->tok);
378 rew_last(mdoc, n);
379 }
380
381 static void
382 break_intermediate(struct roff_node *n, struct roff_node *breaker)
383 {
384 if (n != breaker &&
385 n->type != ROFFT_BLOCK && n->type != ROFFT_HEAD &&
386 (n->type != ROFFT_BODY || n->end != ENDBODY_NOT))
387 n = n->parent;
388 while (n != breaker) {
389 if ( ! (n->flags & NODE_VALID))
390 n->flags |= NODE_BROKEN;
391 n = n->parent;
392 }
393 }
394
395 /*
396 * If there is an open sub-block of the target requiring
397 * explicit close-out, postpone closing out the target until
398 * the rew_pending() call closing out the sub-block.
399 */
400 static int
401 find_pending(struct roff_man *mdoc, enum roff_tok tok, int line, int ppos,
402 struct roff_node *target)
403 {
404 struct roff_node *n;
405 int irc;
406
407 if (target->flags & NODE_VALID)
408 return 0;
409
410 irc = 0;
411 for (n = mdoc->last; n != NULL && n != target; n = n->parent) {
412 if (n->flags & NODE_ENDED)
413 continue;
414 if (n->type == ROFFT_BLOCK &&
415 mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
416 irc = 1;
417 break_intermediate(mdoc->last, target);
418 if (target->type == ROFFT_HEAD)
419 target->flags |= NODE_ENDED;
420 else if ( ! (target->flags & NODE_ENDED)) {
421 mandoc_vmsg(MANDOCERR_BLK_NEST,
422 mdoc->parse, line, ppos,
423 "%s breaks %s", roff_name[tok],
424 roff_name[n->tok]);
425 mdoc_endbody_alloc(mdoc, line, ppos,
426 tok, target);
427 }
428 }
429 }
430 return irc;
431 }
432
433 /*
434 * Allocate a word and check whether it's punctuation or not.
435 * Punctuation consists of those tokens found in mdoc_isdelim().
436 */
437 static void
438 dword(struct roff_man *mdoc, int line, int col, const char *p,
439 enum mdelim d, int may_append)
440 {
441
442 if (d == DELIM_MAX)
443 d = mdoc_isdelim(p);
444
445 if (may_append &&
446 ! (mdoc->flags & (MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF)) &&
447 d == DELIM_NONE && mdoc->last->type == ROFFT_TEXT &&
448 mdoc_isdelim(mdoc->last->string) == DELIM_NONE) {
449 roff_word_append(mdoc, p);
450 return;
451 }
452
453 roff_word_alloc(mdoc, line, col, p);
454
455 /*
456 * If the word consists of a bare delimiter,
457 * flag the new node accordingly,
458 * unless doing so was vetoed by the invoking macro.
459 * Always clear the veto, it is only valid for one word.
460 */
461
462 if (d == DELIM_OPEN)
463 mdoc->last->flags |= NODE_DELIMO;
464 else if (d == DELIM_CLOSE &&
465 ! (mdoc->flags & MDOC_NODELIMC) &&
466 mdoc->last->parent->tok != MDOC_Fd)
467 mdoc->last->flags |= NODE_DELIMC;
468 mdoc->flags &= ~MDOC_NODELIMC;
469 }
470
471 static void
472 append_delims(struct roff_man *mdoc, int line, int *pos, char *buf)
473 {
474 char *p;
475 int la;
476
477 if (buf[*pos] == '\0')
478 return;
479
480 for (;;) {
481 la = *pos;
482 if (mdoc_args(mdoc, line, pos, buf, TOKEN_NONE, &p) ==
483 ARGS_EOLN)
484 break;
485 dword(mdoc, line, la, p, DELIM_MAX, 1);
486
487 /*
488 * If we encounter end-of-sentence symbols, then trigger
489 * the double-space.
490 *
491 * XXX: it's easy to allow this to propagate outward to
492 * the last symbol, such that `. )' will cause the
493 * correct double-spacing. However, (1) groff isn't
494 * smart enough to do this and (2) it would require
495 * knowing which symbols break this behaviour, for
496 * example, `. ;' shouldn't propagate the double-space.
497 */
498
499 if (mandoc_eos(p, strlen(p)))
500 mdoc->last->flags |= NODE_EOS;
501 }
502 }
503
504 /*
505 * Parse one word.
506 * If it is a macro, call it and return 1.
507 * Otherwise, allocate it and return 0.
508 */
509 static int
510 macro_or_word(MACRO_PROT_ARGS, int parsed)
511 {
512 char *p;
513 int ntok;
514
515 p = buf + ppos;
516 ntok = TOKEN_NONE;
517 if (*p == '"')
518 p++;
519 else if (parsed && ! (mdoc->flags & MDOC_PHRASELIT))
520 ntok = lookup(mdoc, tok, line, ppos, p);
521
522 if (ntok == TOKEN_NONE) {
523 dword(mdoc, line, ppos, p, DELIM_MAX, tok == TOKEN_NONE ||
524 mdoc_macros[tok].flags & MDOC_JOIN);
525 return 0;
526 } else {
527 if (tok != TOKEN_NONE &&
528 mdoc_macros[tok].fp == in_line_eoln)
529 rew_elem(mdoc, tok);
530 mdoc_macro(mdoc, ntok, line, ppos, pos, buf);
531 if (tok == TOKEN_NONE)
532 append_delims(mdoc, line, pos, buf);
533 return 1;
534 }
535 }
536
537 /*
538 * Close out block partial/full explicit.
539 */
540 static void
541 blk_exp_close(MACRO_PROT_ARGS)
542 {
543 struct roff_node *body; /* Our own body. */
544 struct roff_node *endbody; /* Our own end marker. */
545 struct roff_node *itblk; /* An It block starting later. */
546 struct roff_node *later; /* A sub-block starting later. */
547 struct roff_node *n; /* Search back to our block. */
548 struct roff_node *target; /* For find_pending(). */
549
550 int j, lastarg, maxargs, nl, pending;
551 enum margserr ac;
552 enum roff_tok atok, ntok;
553 char *p;
554
555 nl = MDOC_NEWLINE & mdoc->flags;
556
557 switch (tok) {
558 case MDOC_Ec:
559 maxargs = 1;
560 break;
561 case MDOC_Ek:
562 mdoc->flags &= ~MDOC_KEEP;
563 /* FALLTHROUGH */
564 default:
565 maxargs = 0;
566 break;
567 }
568
569 /* Search backwards for the beginning of our own body. */
570
571 atok = rew_alt(tok);
572 body = NULL;
573 for (n = mdoc->last; n; n = n->parent) {
574 if (n->flags & NODE_ENDED || n->tok != atok ||
575 n->type != ROFFT_BODY || n->end != ENDBODY_NOT)
576 continue;
577 body = n;
578 break;
579 }
580
581 /*
582 * Search backwards for beginnings of blocks,
583 * both of our own and of pending sub-blocks.
584 */
585
586 endbody = itblk = later = NULL;
587 for (n = mdoc->last; n; n = n->parent) {
588 if (n->flags & NODE_ENDED)
589 continue;
590
591 /*
592 * Mismatching end macros can never break anything
593 * and we only care about the breaking of BLOCKs.
594 */
595
596 if (body == NULL || n->type != ROFFT_BLOCK)
597 continue;
598
599 /*
600 * SYNOPSIS name blocks can not be broken themselves,
601 * but they do get broken together with a broken child.
602 */
603
604 if (n->tok == MDOC_Nm) {
605 if (later != NULL)
606 n->flags |= NODE_BROKEN | NODE_ENDED;
607 continue;
608 }
609
610 if (n->tok == MDOC_It) {
611 itblk = n;
612 continue;
613 }
614
615 if (atok == n->tok) {
616
617 /*
618 * Found the start of our own block.
619 * When there is no pending sub block,
620 * just proceed to closing out.
621 */
622
623 if (later == NULL ||
624 (tok == MDOC_El && itblk == NULL))
625 break;
626
627 /*
628 * When there is a pending sub block, postpone
629 * closing out the current block until the
630 * rew_pending() closing out the sub-block.
631 * Mark the place where the formatting - but not
632 * the scope - of the current block ends.
633 */
634
635 mandoc_vmsg(MANDOCERR_BLK_NEST, mdoc->parse,
636 line, ppos, "%s breaks %s",
637 roff_name[atok], roff_name[later->tok]);
638
639 endbody = mdoc_endbody_alloc(mdoc, line, ppos,
640 atok, body);
641
642 if (tok == MDOC_El)
643 itblk->flags |= NODE_ENDED | NODE_BROKEN;
644
645 /*
646 * If a block closing macro taking arguments
647 * breaks another block, put the arguments
648 * into the end marker.
649 */
650
651 if (maxargs)
652 mdoc->next = ROFF_NEXT_CHILD;
653 break;
654 }
655
656 /*
657 * Explicit blocks close out description lines, but
658 * even those can get broken together with a child.
659 */
660
661 if (n->tok == MDOC_Nd) {
662 if (later != NULL)
663 n->flags |= NODE_BROKEN | NODE_ENDED;
664 else
665 rew_last(mdoc, n);
666 continue;
667 }
668
669 /* Breaking an open sub block. */
670
671 break_intermediate(mdoc->last, body);
672 n->flags |= NODE_BROKEN;
673 if (later == NULL)
674 later = n;
675 }
676
677 if (body == NULL) {
678 mandoc_msg(MANDOCERR_BLK_NOTOPEN, mdoc->parse,
679 line, ppos, roff_name[tok]);
680 if (maxargs && endbody == NULL) {
681 /*
682 * Stray .Ec without previous .Eo:
683 * Break the output line, keep the arguments.
684 */
685 roff_elem_alloc(mdoc, line, ppos, MDOC_br);
686 rew_elem(mdoc, MDOC_br);
687 }
688 } else if (endbody == NULL) {
689 rew_last(mdoc, body);
690 if (maxargs)
691 mdoc_tail_alloc(mdoc, line, ppos, atok);
692 }
693
694 if ( ! (mdoc_macros[tok].flags & MDOC_PARSED)) {
695 if (buf[*pos] != '\0')
696 mandoc_vmsg(MANDOCERR_ARG_SKIP,
697 mdoc->parse, line, ppos,
698 "%s %s", roff_name[tok],
699 buf + *pos);
700 if (endbody == NULL && n != NULL)
701 rew_pending(mdoc, n);
702 return;
703 }
704
705 if (endbody != NULL)
706 n = endbody;
707
708 ntok = TOKEN_NONE;
709 for (j = 0; ; j++) {
710 lastarg = *pos;
711
712 if (j == maxargs && n != NULL)
713 rew_last(mdoc, n);
714
715 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
716 if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
717 break;
718
719 ntok = ac == ARGS_QWORD ? TOKEN_NONE :
720 lookup(mdoc, tok, line, lastarg, p);
721
722 if (ntok == TOKEN_NONE) {
723 dword(mdoc, line, lastarg, p, DELIM_MAX,
724 MDOC_JOIN & mdoc_macros[tok].flags);
725 continue;
726 }
727
728 if (n != NULL)
729 rew_last(mdoc, n);
730 mdoc->flags &= ~MDOC_NEWLINE;
731 mdoc_macro(mdoc, ntok, line, lastarg, pos, buf);
732 break;
733 }
734
735 if (n != NULL) {
736 pending = 0;
737 if (ntok != TOKEN_NONE && n->flags & NODE_BROKEN) {
738 target = n;
739 do
740 target = target->parent;
741 while ( ! (target->flags & NODE_ENDED));
742 pending = find_pending(mdoc, ntok, line, ppos, target);
743 }
744 if ( ! pending)
745 rew_pending(mdoc, n);
746 }
747 if (nl)
748 append_delims(mdoc, line, pos, buf);
749 }
750
751 static void
752 in_line(MACRO_PROT_ARGS)
753 {
754 int la, scope, cnt, firstarg, mayopen, nc, nl;
755 enum roff_tok ntok;
756 enum margserr ac;
757 enum mdelim d;
758 struct mdoc_arg *arg;
759 char *p;
760
761 nl = MDOC_NEWLINE & mdoc->flags;
762
763 /*
764 * Whether we allow ignored elements (those without content,
765 * usually because of reserved words) to squeak by.
766 */
767
768 switch (tok) {
769 case MDOC_An:
770 case MDOC_Ar:
771 case MDOC_Fl:
772 case MDOC_Mt:
773 case MDOC_Nm:
774 case MDOC_Pa:
775 nc = 1;
776 break;
777 default:
778 nc = 0;
779 break;
780 }
781
782 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
783
784 d = DELIM_NONE;
785 firstarg = 1;
786 mayopen = 1;
787 for (cnt = scope = 0;; ) {
788 la = *pos;
789 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
790
791 /*
792 * At the end of a macro line,
793 * opening delimiters do not suppress spacing.
794 */
795
796 if (ac == ARGS_EOLN) {
797 if (d == DELIM_OPEN)
798 mdoc->last->flags &= ~NODE_DELIMO;
799 break;
800 }
801
802 /*
803 * The rest of the macro line is only punctuation,
804 * to be handled by append_delims().
805 * If there were no other arguments,
806 * do not allow the first one to suppress spacing,
807 * even if it turns out to be a closing one.
808 */
809
810 if (ac == ARGS_PUNCT) {
811 if (cnt == 0 && (nc == 0 || tok == MDOC_An))
812 mdoc->flags |= MDOC_NODELIMC;
813 break;
814 }
815
816 ntok = (ac == ARGS_QWORD || (tok == MDOC_Fn && !cnt)) ?
817 TOKEN_NONE : lookup(mdoc, tok, line, la, p);
818
819 /*
820 * In this case, we've located a submacro and must
821 * execute it. Close out scope, if open. If no
822 * elements have been generated, either create one (nc)
823 * or raise a warning.
824 */
825
826 if (ntok != TOKEN_NONE) {
827 if (scope)
828 rew_elem(mdoc, tok);
829 if (nc && ! cnt) {
830 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
831 rew_last(mdoc, mdoc->last);
832 } else if ( ! nc && ! cnt) {
833 mdoc_argv_free(arg);
834 mandoc_msg(MANDOCERR_MACRO_EMPTY,
835 mdoc->parse, line, ppos,
836 roff_name[tok]);
837 }
838 mdoc_macro(mdoc, ntok, line, la, pos, buf);
839 if (nl)
840 append_delims(mdoc, line, pos, buf);
841 return;
842 }
843
844 /*
845 * Non-quote-enclosed punctuation. Set up our scope, if
846 * a word; rewind the scope, if a delimiter; then append
847 * the word.
848 */
849
850 d = ac == ARGS_QWORD ? DELIM_NONE : mdoc_isdelim(p);
851
852 if (DELIM_NONE != d) {
853 /*
854 * If we encounter closing punctuation, no word
855 * has been emitted, no scope is open, and we're
856 * allowed to have an empty element, then start
857 * a new scope.
858 */
859 if ((d == DELIM_CLOSE ||
860 (d == DELIM_MIDDLE && tok == MDOC_Fl)) &&
861 !cnt && !scope && nc && mayopen) {
862 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
863 scope = 1;
864 cnt++;
865 if (tok == MDOC_Nm)
866 mayopen = 0;
867 }
868 /*
869 * Close out our scope, if one is open, before
870 * any punctuation.
871 */
872 if (scope)
873 rew_elem(mdoc, tok);
874 scope = 0;
875 if (tok == MDOC_Fn)
876 mayopen = 0;
877 } else if (mayopen && !scope) {
878 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
879 scope = 1;
880 cnt++;
881 }
882
883 dword(mdoc, line, la, p, d,
884 mdoc_macros[tok].flags & MDOC_JOIN);
885
886 /*
887 * If the first argument is a closing delimiter,
888 * do not suppress spacing before it.
889 */
890
891 if (firstarg && d == DELIM_CLOSE && !nc)
892 mdoc->last->flags &= ~NODE_DELIMC;
893 firstarg = 0;
894
895 /*
896 * `Fl' macros have their scope re-opened with each new
897 * word so that the `-' can be added to each one without
898 * having to parse out spaces.
899 */
900 if (scope && tok == MDOC_Fl) {
901 rew_elem(mdoc, tok);
902 scope = 0;
903 }
904 }
905
906 if (scope && tok != MDOC_Lk) {
907 rew_elem(mdoc, tok);
908 scope = 0;
909 }
910
911 /*
912 * If no elements have been collected and we're allowed to have
913 * empties (nc), open a scope and close it out. Otherwise,
914 * raise a warning.
915 */
916
917 if ( ! cnt) {
918 if (nc) {
919 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
920 rew_last(mdoc, mdoc->last);
921 } else {
922 mdoc_argv_free(arg);
923 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
924 line, ppos, roff_name[tok]);
925 }
926 }
927 if (nl)
928 append_delims(mdoc, line, pos, buf);
929 if (scope)
930 rew_elem(mdoc, tok);
931 }
932
933 static void
934 blk_full(MACRO_PROT_ARGS)
935 {
936 int la, nl, parsed;
937 struct mdoc_arg *arg;
938 struct roff_node *blk; /* Our own or a broken block. */
939 struct roff_node *head; /* Our own head. */
940 struct roff_node *body; /* Our own body. */
941 struct roff_node *n;
942 enum margserr ac, lac;
943 char *p;
944
945 nl = MDOC_NEWLINE & mdoc->flags;
946
947 if (buf[*pos] == '\0' && (tok == MDOC_Sh || tok == MDOC_Ss)) {
948 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
949 line, ppos, roff_name[tok]);
950 return;
951 }
952
953 if ( ! (mdoc_macros[tok].flags & MDOC_EXPLICIT)) {
954
955 /* Here, tok is one of Sh Ss Nm Nd It. */
956
957 blk = NULL;
958 for (n = mdoc->last; n != NULL; n = n->parent) {
959 if (n->flags & NODE_ENDED) {
960 if ( ! (n->flags & NODE_VALID))
961 n->flags |= NODE_BROKEN;
962 continue;
963 }
964 if (n->type != ROFFT_BLOCK)
965 continue;
966
967 if (tok == MDOC_It && n->tok == MDOC_Bl) {
968 if (blk != NULL) {
969 mandoc_vmsg(MANDOCERR_BLK_BROKEN,
970 mdoc->parse, line, ppos,
971 "It breaks %s",
972 roff_name[blk->tok]);
973 rew_pending(mdoc, blk);
974 }
975 break;
976 }
977
978 if (mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
979 switch (tok) {
980 case MDOC_Sh:
981 case MDOC_Ss:
982 mandoc_vmsg(MANDOCERR_BLK_BROKEN,
983 mdoc->parse, line, ppos,
984 "%s breaks %s", roff_name[tok],
985 roff_name[n->tok]);
986 rew_pending(mdoc, n);
987 n = mdoc->last;
988 continue;
989 case MDOC_It:
990 /* Delay in case it's astray. */
991 blk = n;
992 continue;
993 default:
994 break;
995 }
996 break;
997 }
998
999 /* Here, n is one of Sh Ss Nm Nd It. */
1000
1001 if (tok != MDOC_Sh && (n->tok == MDOC_Sh ||
1002 (tok != MDOC_Ss && (n->tok == MDOC_Ss ||
1003 (tok != MDOC_It && n->tok == MDOC_It)))))
1004 break;
1005
1006 /* Item breaking an explicit block. */
1007
1008 if (blk != NULL) {
1009 mandoc_vmsg(MANDOCERR_BLK_BROKEN,
1010 mdoc->parse, line, ppos,
1011 "It breaks %s", roff_name[blk->tok]);
1012 rew_pending(mdoc, blk);
1013 blk = NULL;
1014 }
1015
1016 /* Close out prior implicit scopes. */
1017
1018 rew_pending(mdoc, n);
1019 }
1020
1021 /* Skip items outside lists. */
1022
1023 if (tok == MDOC_It && (n == NULL || n->tok != MDOC_Bl)) {
1024 mandoc_vmsg(MANDOCERR_IT_STRAY, mdoc->parse,
1025 line, ppos, "It %s", buf + *pos);
1026 roff_elem_alloc(mdoc, line, ppos, MDOC_br);
1027 rew_elem(mdoc, MDOC_br);
1028 return;
1029 }
1030 }
1031
1032 /*
1033 * This routine accommodates implicitly- and explicitly-scoped
1034 * macro openings. Implicit ones first close out prior scope
1035 * (seen above). Delay opening the head until necessary to
1036 * allow leading punctuation to print. Special consideration
1037 * for `It -column', which has phrase-part syntax instead of
1038 * regular child nodes.
1039 */
1040
1041 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1042 blk = mdoc_block_alloc(mdoc, line, ppos, tok, arg);
1043 head = body = NULL;
1044
1045 /*
1046 * Exception: Heads of `It' macros in `-diag' lists are not
1047 * parsed, even though `It' macros in general are parsed.
1048 */
1049
1050 parsed = tok != MDOC_It ||
1051 mdoc->last->parent->tok != MDOC_Bl ||
1052 mdoc->last->parent->norm->Bl.type != LIST_diag;
1053
1054 /*
1055 * The `Nd' macro has all arguments in its body: it's a hybrid
1056 * of block partial-explicit and full-implicit. Stupid.
1057 */
1058
1059 if (tok == MDOC_Nd) {
1060 head = roff_head_alloc(mdoc, line, ppos, tok);
1061 rew_last(mdoc, head);
1062 body = roff_body_alloc(mdoc, line, ppos, tok);
1063 }
1064
1065 if (tok == MDOC_Bk)
1066 mdoc->flags |= MDOC_KEEP;
1067
1068 ac = ARGS_EOLN;
1069 for (;;) {
1070
1071 /*
1072 * If we are right after a tab character,
1073 * do not parse the first word for macros.
1074 */
1075
1076 if (mdoc->flags & MDOC_PHRASEQN) {
1077 mdoc->flags &= ~MDOC_PHRASEQN;
1078 mdoc->flags |= MDOC_PHRASEQF;
1079 }
1080
1081 la = *pos;
1082 lac = ac;
1083 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1084 if (ac == ARGS_EOLN) {
1085 if (lac != ARGS_PHRASE ||
1086 ! (mdoc->flags & MDOC_PHRASEQF))
1087 break;
1088
1089 /*
1090 * This line ends in a tab; start the next
1091 * column now, with a leading blank.
1092 */
1093
1094 if (body != NULL)
1095 rew_last(mdoc, body);
1096 body = roff_body_alloc(mdoc, line, ppos, tok);
1097 roff_word_alloc(mdoc, line, ppos, "\\&");
1098 break;
1099 }
1100
1101 if (tok == MDOC_Bd || tok == MDOC_Bk) {
1102 mandoc_vmsg(MANDOCERR_ARG_EXCESS,
1103 mdoc->parse, line, la, "%s ... %s",
1104 roff_name[tok], buf + la);
1105 break;
1106 }
1107 if (tok == MDOC_Rs) {
1108 mandoc_vmsg(MANDOCERR_ARG_SKIP, mdoc->parse,
1109 line, la, "Rs %s", buf + la);
1110 break;
1111 }
1112 if (ac == ARGS_PUNCT)
1113 break;
1114
1115 /*
1116 * Emit leading punctuation (i.e., punctuation before
1117 * the ROFFT_HEAD) for non-phrase types.
1118 */
1119
1120 if (head == NULL &&
1121 ac != ARGS_PHRASE &&
1122 ac != ARGS_QWORD &&
1123 mdoc_isdelim(p) == DELIM_OPEN) {
1124 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1125 continue;
1126 }
1127
1128 /* Open a head if one hasn't been opened. */
1129
1130 if (head == NULL)
1131 head = roff_head_alloc(mdoc, line, ppos, tok);
1132
1133 if (ac == ARGS_PHRASE) {
1134
1135 /*
1136 * If we haven't opened a body yet, rewind the
1137 * head; if we have, rewind that instead.
1138 */
1139
1140 rew_last(mdoc, body == NULL ? head : body);
1141 body = roff_body_alloc(mdoc, line, ppos, tok);
1142
1143 /* Process to the tab or to the end of the line. */
1144
1145 mdoc->flags |= MDOC_PHRASE;
1146 parse_rest(mdoc, TOKEN_NONE, line, &la, buf);
1147 mdoc->flags &= ~MDOC_PHRASE;
1148
1149 /* There may have been `Ta' macros. */
1150
1151 while (body->next != NULL)
1152 body = body->next;
1153 continue;
1154 }
1155
1156 if (macro_or_word(mdoc, tok, line, la, pos, buf, parsed))
1157 break;
1158 }
1159
1160 if (blk->flags & NODE_VALID)
1161 return;
1162 if (head == NULL)
1163 head = roff_head_alloc(mdoc, line, ppos, tok);
1164 if (nl && tok != MDOC_Bd && tok != MDOC_Bl && tok != MDOC_Rs)
1165 append_delims(mdoc, line, pos, buf);
1166 if (body != NULL)
1167 goto out;
1168 if (find_pending(mdoc, tok, line, ppos, head))
1169 return;
1170
1171 /* Close out scopes to remain in a consistent state. */
1172
1173 rew_last(mdoc, head);
1174 body = roff_body_alloc(mdoc, line, ppos, tok);
1175 out:
1176 if (mdoc->flags & MDOC_FREECOL) {
1177 rew_last(mdoc, body);
1178 rew_last(mdoc, blk);
1179 mdoc->flags &= ~MDOC_FREECOL;
1180 }
1181 }
1182
1183 static void
1184 blk_part_imp(MACRO_PROT_ARGS)
1185 {
1186 int la, nl;
1187 enum margserr ac;
1188 char *p;
1189 struct roff_node *blk; /* saved block context */
1190 struct roff_node *body; /* saved body context */
1191 struct roff_node *n;
1192
1193 nl = MDOC_NEWLINE & mdoc->flags;
1194
1195 /*
1196 * A macro that spans to the end of the line. This is generally
1197 * (but not necessarily) called as the first macro. The block
1198 * has a head as the immediate child, which is always empty,
1199 * followed by zero or more opening punctuation nodes, then the
1200 * body (which may be empty, depending on the macro), then zero
1201 * or more closing punctuation nodes.
1202 */
1203
1204 blk = mdoc_block_alloc(mdoc, line, ppos, tok, NULL);
1205 rew_last(mdoc, roff_head_alloc(mdoc, line, ppos, tok));
1206
1207 /*
1208 * Open the body scope "on-demand", that is, after we've
1209 * processed all our the leading delimiters (open parenthesis,
1210 * etc.).
1211 */
1212
1213 for (body = NULL; ; ) {
1214 la = *pos;
1215 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1216 if (ac == ARGS_EOLN || ac == ARGS_PUNCT)
1217 break;
1218
1219 if (body == NULL && ac != ARGS_QWORD &&
1220 mdoc_isdelim(p) == DELIM_OPEN) {
1221 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1222 continue;
1223 }
1224
1225 if (body == NULL)
1226 body = roff_body_alloc(mdoc, line, ppos, tok);
1227
1228 if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1229 break;
1230 }
1231 if (body == NULL)
1232 body = roff_body_alloc(mdoc, line, ppos, tok);
1233
1234 if (find_pending(mdoc, tok, line, ppos, body))
1235 return;
1236
1237 rew_last(mdoc, body);
1238 if (nl)
1239 append_delims(mdoc, line, pos, buf);
1240 rew_pending(mdoc, blk);
1241
1242 /* Move trailing .Ns out of scope. */
1243
1244 for (n = body->child; n && n->next; n = n->next)
1245 /* Do nothing. */ ;
1246 if (n && n->tok == MDOC_Ns)
1247 mdoc_node_relink(mdoc, n);
1248 }
1249
1250 static void
1251 blk_part_exp(MACRO_PROT_ARGS)
1252 {
1253 int la, nl;
1254 enum margserr ac;
1255 struct roff_node *head; /* keep track of head */
1256 char *p;
1257
1258 nl = MDOC_NEWLINE & mdoc->flags;
1259
1260 /*
1261 * The opening of an explicit macro having zero or more leading
1262 * punctuation nodes; a head with optional single element (the
1263 * case of `Eo'); and a body that may be empty.
1264 */
1265
1266 roff_block_alloc(mdoc, line, ppos, tok);
1267 head = NULL;
1268 for (;;) {
1269 la = *pos;
1270 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1271 if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
1272 break;
1273
1274 /* Flush out leading punctuation. */
1275
1276 if (head == NULL && ac != ARGS_QWORD &&
1277 mdoc_isdelim(p) == DELIM_OPEN) {
1278 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1279 continue;
1280 }
1281
1282 if (head == NULL) {
1283 head = roff_head_alloc(mdoc, line, ppos, tok);
1284 if (tok == MDOC_Eo) /* Not parsed. */
1285 dword(mdoc, line, la, p, DELIM_MAX, 0);
1286 rew_last(mdoc, head);
1287 roff_body_alloc(mdoc, line, ppos, tok);
1288 if (tok == MDOC_Eo)
1289 continue;
1290 }
1291
1292 if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1293 break;
1294 }
1295
1296 /* Clean-up to leave in a consistent state. */
1297
1298 if (head == NULL) {
1299 rew_last(mdoc, roff_head_alloc(mdoc, line, ppos, tok));
1300 roff_body_alloc(mdoc, line, ppos, tok);
1301 }
1302 if (nl)
1303 append_delims(mdoc, line, pos, buf);
1304 }
1305
1306 static void
1307 in_line_argn(MACRO_PROT_ARGS)
1308 {
1309 struct mdoc_arg *arg;
1310 char *p;
1311 enum margserr ac;
1312 enum roff_tok ntok;
1313 int state; /* arg#; -1: not yet open; -2: closed */
1314 int la, maxargs, nl;
1315
1316 nl = mdoc->flags & MDOC_NEWLINE;
1317
1318 /*
1319 * A line macro that has a fixed number of arguments (maxargs).
1320 * Only open the scope once the first non-leading-punctuation is
1321 * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1322 * keep it open until the maximum number of arguments are
1323 * exhausted.
1324 */
1325
1326 switch (tok) {
1327 case MDOC_Ap:
1328 case MDOC_Ns:
1329 case MDOC_Ux:
1330 maxargs = 0;
1331 break;
1332 case MDOC_Bx:
1333 case MDOC_Es:
1334 case MDOC_Xr:
1335 maxargs = 2;
1336 break;
1337 default:
1338 maxargs = 1;
1339 break;
1340 }
1341
1342 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1343
1344 state = -1;
1345 p = NULL;
1346 for (;;) {
1347 la = *pos;
1348 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1349
1350 if (ac == ARGS_WORD && state == -1 &&
1351 ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) &&
1352 mdoc_isdelim(p) == DELIM_OPEN) {
1353 dword(mdoc, line, la, p, DELIM_OPEN, 0);
1354 continue;
1355 }
1356
1357 if (state == -1 && tok != MDOC_In &&
1358 tok != MDOC_St && tok != MDOC_Xr) {
1359 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1360 state = 0;
1361 }
1362
1363 if (ac == ARGS_PUNCT || ac == ARGS_EOLN) {
1364 if (abs(state) < 2 && tok == MDOC_Pf)
1365 mandoc_vmsg(MANDOCERR_PF_SKIP,
1366 mdoc->parse, line, ppos, "Pf %s",
1367 p == NULL ? "at eol" : p);
1368 break;
1369 }
1370
1371 if (state == maxargs) {
1372 rew_elem(mdoc, tok);
1373 state = -2;
1374 }
1375
1376 ntok = (ac == ARGS_QWORD || (tok == MDOC_Pf && state == 0)) ?
1377 TOKEN_NONE : lookup(mdoc, tok, line, la, p);
1378
1379 if (ntok != TOKEN_NONE) {
1380 if (state >= 0) {
1381 rew_elem(mdoc, tok);
1382 state = -2;
1383 }
1384 mdoc_macro(mdoc, ntok, line, la, pos, buf);
1385 break;
1386 }
1387
1388 if (ac == ARGS_QWORD ||
1389 mdoc_macros[tok].flags & MDOC_IGNDELIM ||
1390 mdoc_isdelim(p) == DELIM_NONE) {
1391 if (state == -1) {
1392 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1393 state = 1;
1394 } else if (state >= 0)
1395 state++;
1396 } else if (state >= 0) {
1397 rew_elem(mdoc, tok);
1398 state = -2;
1399 }
1400
1401 dword(mdoc, line, la, p, DELIM_MAX,
1402 mdoc_macros[tok].flags & MDOC_JOIN);
1403 }
1404
1405 if (state == -1) {
1406 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
1407 line, ppos, roff_name[tok]);
1408 return;
1409 }
1410
1411 if (state == 0 && tok == MDOC_Pf)
1412 append_delims(mdoc, line, pos, buf);
1413 if (state >= 0)
1414 rew_elem(mdoc, tok);
1415 if (nl)
1416 append_delims(mdoc, line, pos, buf);
1417 }
1418
1419 static void
1420 in_line_eoln(MACRO_PROT_ARGS)
1421 {
1422 struct roff_node *n;
1423 struct mdoc_arg *arg;
1424
1425 if ((tok == MDOC_Pp || tok == MDOC_Lp) &&
1426 ! (mdoc->flags & MDOC_SYNOPSIS)) {
1427 n = mdoc->last;
1428 if (mdoc->next == ROFF_NEXT_SIBLING)
1429 n = n->parent;
1430 if (n->tok == MDOC_Nm)
1431 rew_last(mdoc, n->parent);
1432 }
1433
1434 if (buf[*pos] == '\0' &&
1435 (tok == MDOC_Fd || *roff_name[tok] == '%')) {
1436 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
1437 line, ppos, roff_name[tok]);
1438 return;
1439 }
1440
1441 mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1442 mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1443 if (parse_rest(mdoc, tok, line, pos, buf))
1444 return;
1445 rew_elem(mdoc, tok);
1446 }
1447
1448 /*
1449 * The simplest argument parser available: Parse the remaining
1450 * words until the end of the phrase or line and return 0
1451 * or until the next macro, call that macro, and return 1.
1452 */
1453 static int
1454 parse_rest(struct roff_man *mdoc, enum roff_tok tok,
1455 int line, int *pos, char *buf)
1456 {
1457 int la;
1458
1459 for (;;) {
1460 la = *pos;
1461 if (mdoc_args(mdoc, line, pos, buf, tok, NULL) == ARGS_EOLN)
1462 return 0;
1463 if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1464 return 1;
1465 }
1466 }
1467
1468 static void
1469 ctx_synopsis(MACRO_PROT_ARGS)
1470 {
1471
1472 if (~mdoc->flags & (MDOC_SYNOPSIS | MDOC_NEWLINE))
1473 in_line(mdoc, tok, line, ppos, pos, buf);
1474 else if (tok == MDOC_Nm)
1475 blk_full(mdoc, tok, line, ppos, pos, buf);
1476 else {
1477 assert(tok == MDOC_Vt);
1478 blk_part_imp(mdoc, tok, line, ppos, pos, buf);
1479 }
1480 }
1481
1482 /*
1483 * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1484 * They're unusual because they're basically free-form text until a
1485 * macro is encountered.
1486 */
1487 static void
1488 phrase_ta(MACRO_PROT_ARGS)
1489 {
1490 struct roff_node *body, *n;
1491
1492 /* Make sure we are in a column list or ignore this macro. */
1493
1494 body = NULL;
1495 for (n = mdoc->last; n != NULL; n = n->parent) {
1496 if (n->flags & NODE_ENDED)
1497 continue;
1498 if (n->tok == MDOC_It && n->type == ROFFT_BODY)
1499 body = n;
1500 if (n->tok == MDOC_Bl && n->end == ENDBODY_NOT)
1501 break;
1502 }
1503
1504 if (n == NULL || n->norm->Bl.type != LIST_column) {
1505 mandoc_msg(MANDOCERR_TA_STRAY, mdoc->parse,
1506 line, ppos, "Ta");
1507 return;
1508 }
1509
1510 /* Advance to the next column. */
1511
1512 rew_last(mdoc, body);
1513 roff_body_alloc(mdoc, line, ppos, MDOC_It);
1514 parse_rest(mdoc, TOKEN_NONE, line, pos, buf);
1515 }
A git conversion mirror of mandoc.bsd.lv