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