]> 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
Multiple fixes with respect to in-line macros:
[mandoc.git] / mdoc_macro.c
1 /* $Id: mdoc_macro.c,v 1.144 2014/11/17 06:44:58 schwarze Exp $ */
2 /*
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012, 2013, 2014 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 AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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 "mdoc.h"
30 #include "mandoc.h"
31 #include "libmdoc.h"
32 #include "libmandoc.h"
33
34 enum rew { /* see rew_dohalt() */
35 REWIND_NONE,
36 REWIND_THIS,
37 REWIND_MORE,
38 REWIND_FORCE,
39 REWIND_LATER,
40 REWIND_ERROR
41 };
42
43 static int blk_full(MACRO_PROT_ARGS);
44 static int blk_exp_close(MACRO_PROT_ARGS);
45 static int blk_part_exp(MACRO_PROT_ARGS);
46 static int blk_part_imp(MACRO_PROT_ARGS);
47 static int ctx_synopsis(MACRO_PROT_ARGS);
48 static int in_line_eoln(MACRO_PROT_ARGS);
49 static int in_line_argn(MACRO_PROT_ARGS);
50 static int in_line(MACRO_PROT_ARGS);
51 static int phrase_ta(MACRO_PROT_ARGS);
52
53 static int dword(struct mdoc *, int, int, const char *,
54 enum mdelim, int);
55 static int append_delims(struct mdoc *,
56 int, int *, char *);
57 static enum mdoct lookup(enum mdoct, const char *);
58 static enum mdoct lookup_raw(const char *);
59 static int make_pending(struct mdoc_node *, enum mdoct,
60 struct mdoc *, int, int);
61 static int phrase(struct mdoc *, int, int, char *);
62 static enum mdoct rew_alt(enum mdoct);
63 static enum rew rew_dohalt(enum mdoct, enum mdoc_type,
64 const struct mdoc_node *);
65 static int rew_elem(struct mdoc *, enum mdoct);
66 static int rew_last(struct mdoc *,
67 const struct mdoc_node *);
68 static int rew_sub(enum mdoc_type, struct mdoc *,
69 enum mdoct, int, int);
70
71 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
72 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ap */
73 { in_line_eoln, MDOC_PROLOGUE }, /* Dd */
74 { in_line_eoln, MDOC_PROLOGUE }, /* Dt */
75 { in_line_eoln, MDOC_PROLOGUE }, /* Os */
76 { blk_full, MDOC_PARSED | MDOC_JOIN }, /* Sh */
77 { blk_full, MDOC_PARSED | MDOC_JOIN }, /* Ss */
78 { in_line_eoln, 0 }, /* Pp */
79 { blk_part_imp, MDOC_PARSED | MDOC_JOIN }, /* D1 */
80 { blk_part_imp, MDOC_PARSED | MDOC_JOIN }, /* Dl */
81 { blk_full, MDOC_EXPLICIT }, /* Bd */
82 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ed */
83 { blk_full, MDOC_EXPLICIT }, /* Bl */
84 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* El */
85 { blk_full, MDOC_PARSED | MDOC_JOIN }, /* It */
86 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
87 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* An */
88 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
89 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Cd */
90 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
91 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
92 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
93 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
94 { in_line_eoln, 0 }, /* Ex */
95 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */
96 { in_line_eoln, 0 }, /* Fd */
97 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
98 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */
99 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */
100 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ic */
101 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */
102 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Li */
103 { blk_full, MDOC_JOIN }, /* Nd */
104 { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
105 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
106 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ot */
107 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
108 { in_line_eoln, 0 }, /* Rv */
109 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */
110 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
111 { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
112 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
113 { in_line_eoln, MDOC_JOIN }, /* %A */
114 { in_line_eoln, MDOC_JOIN }, /* %B */
115 { in_line_eoln, MDOC_JOIN }, /* %D */
116 { in_line_eoln, MDOC_JOIN }, /* %I */
117 { in_line_eoln, MDOC_JOIN }, /* %J */
118 { in_line_eoln, 0 }, /* %N */
119 { in_line_eoln, MDOC_JOIN }, /* %O */
120 { in_line_eoln, 0 }, /* %P */
121 { in_line_eoln, MDOC_JOIN }, /* %R */
122 { in_line_eoln, MDOC_JOIN }, /* %T */
123 { in_line_eoln, 0 }, /* %V */
124 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
125 MDOC_EXPLICIT | MDOC_JOIN }, /* Ac */
126 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
127 MDOC_EXPLICIT | MDOC_JOIN }, /* Ao */
128 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Aq */
129 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* At */
130 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
131 MDOC_EXPLICIT | MDOC_JOIN }, /* Bc */
132 { blk_full, MDOC_EXPLICIT }, /* Bf */
133 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
134 MDOC_EXPLICIT | MDOC_JOIN }, /* Bo */
135 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Bq */
136 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */
137 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */
138 { in_line_eoln, 0 }, /* Db */
139 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
140 MDOC_EXPLICIT | MDOC_JOIN }, /* Dc */
141 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
142 MDOC_EXPLICIT | MDOC_JOIN }, /* Do */
143 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Dq */
144 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ec */
145 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ef */
146 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Em */
147 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
148 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */
149 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */
150 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* No */
151 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED |
152 MDOC_IGNDELIM | MDOC_JOIN }, /* Ns */
153 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
154 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
155 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
156 MDOC_EXPLICIT | MDOC_JOIN }, /* Pc */
157 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
158 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
159 MDOC_EXPLICIT | MDOC_JOIN }, /* Po */
160 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Pq */
161 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
162 MDOC_EXPLICIT | MDOC_JOIN }, /* Qc */
163 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ql */
164 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
165 MDOC_EXPLICIT | MDOC_JOIN }, /* Qo */
166 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Qq */
167 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Re */
168 { blk_full, MDOC_EXPLICIT }, /* Rs */
169 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
170 MDOC_EXPLICIT | MDOC_JOIN }, /* Sc */
171 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
172 MDOC_EXPLICIT | MDOC_JOIN }, /* So */
173 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sq */
174 { in_line_eoln, 0 }, /* Sm */
175 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sx */
176 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sy */
177 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
178 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ux */
179 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
180 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
181 { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
182 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
183 MDOC_EXPLICIT | MDOC_JOIN }, /* Fc */
184 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
185 MDOC_EXPLICIT | MDOC_JOIN }, /* Oo */
186 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
187 MDOC_EXPLICIT | MDOC_JOIN }, /* Oc */
188 { blk_full, MDOC_EXPLICIT }, /* Bk */
189 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ek */
190 { in_line_eoln, 0 }, /* Bt */
191 { in_line_eoln, 0 }, /* Hf */
192 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fr */
193 { in_line_eoln, 0 }, /* Ud */
194 { in_line, 0 }, /* Lb */
195 { in_line_eoln, 0 }, /* Lp */
196 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
197 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
198 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Brq */
199 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
200 MDOC_EXPLICIT | MDOC_JOIN }, /* Bro */
201 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
202 MDOC_EXPLICIT | MDOC_JOIN }, /* Brc */
203 { in_line_eoln, MDOC_JOIN }, /* %C */
204 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Es */
205 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* En */
206 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
207 { in_line_eoln, MDOC_JOIN }, /* %Q */
208 { in_line_eoln, 0 }, /* br */
209 { in_line_eoln, 0 }, /* sp */
210 { in_line_eoln, 0 }, /* %U */
211 { phrase_ta, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ta */
212 { in_line_eoln, MDOC_PROLOGUE }, /* ll */
213 };
214
215 const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
216
217
218 /*
219 * This is called at the end of parsing. It must traverse up the tree,
220 * closing out open [implicit] scopes. Obviously, open explicit scopes
221 * are errors.
222 */
223 int
224 mdoc_macroend(struct mdoc *mdoc)
225 {
226 struct mdoc_node *n;
227
228 /* Scan for open explicit scopes. */
229
230 n = MDOC_VALID & mdoc->last->flags ?
231 mdoc->last->parent : mdoc->last;
232
233 for ( ; n; n = n->parent)
234 if (MDOC_BLOCK == n->type &&
235 MDOC_EXPLICIT & mdoc_macros[n->tok].flags)
236 mandoc_msg(MANDOCERR_BLK_NOEND, mdoc->parse,
237 n->line, n->pos, mdoc_macronames[n->tok]);
238
239 /* Rewind to the first. */
240
241 return(rew_last(mdoc, mdoc->first));
242 }
243
244 /*
245 * Look up a macro from within a subsequent context.
246 */
247 static enum mdoct
248 lookup(enum mdoct from, const char *p)
249 {
250
251 if ( ! (MDOC_PARSED & mdoc_macros[from].flags))
252 return(MDOC_MAX);
253 return(lookup_raw(p));
254 }
255
256 /*
257 * Lookup a macro following the initial line macro.
258 */
259 static enum mdoct
260 lookup_raw(const char *p)
261 {
262 enum mdoct res;
263
264 if (MDOC_MAX == (res = mdoc_hash_find(p)))
265 return(MDOC_MAX);
266 if (MDOC_CALLABLE & mdoc_macros[res].flags)
267 return(res);
268 return(MDOC_MAX);
269 }
270
271 static int
272 rew_last(struct mdoc *mdoc, const struct mdoc_node *to)
273 {
274 struct mdoc_node *n, *np;
275
276 assert(to);
277 mdoc->next = MDOC_NEXT_SIBLING;
278
279
280 while (mdoc->last != to) {
281 /*
282 * Save the parent here, because we may delete the
283 * mdoc->last node in the post-validation phase and reset
284 * it to mdoc->last->parent, causing a step in the closing
285 * out to be lost.
286 */
287 np = mdoc->last->parent;
288 if ( ! mdoc_valid_post(mdoc))
289 return(0);
290 n = mdoc->last;
291 mdoc->last = np;
292 assert(mdoc->last);
293 mdoc->last->last = n;
294 }
295
296 return(mdoc_valid_post(mdoc));
297 }
298
299 /*
300 * For a block closing macro, return the corresponding opening one.
301 * Otherwise, return the macro itself.
302 */
303 static enum mdoct
304 rew_alt(enum mdoct tok)
305 {
306 switch (tok) {
307 case MDOC_Ac:
308 return(MDOC_Ao);
309 case MDOC_Bc:
310 return(MDOC_Bo);
311 case MDOC_Brc:
312 return(MDOC_Bro);
313 case MDOC_Dc:
314 return(MDOC_Do);
315 case MDOC_Ec:
316 return(MDOC_Eo);
317 case MDOC_Ed:
318 return(MDOC_Bd);
319 case MDOC_Ef:
320 return(MDOC_Bf);
321 case MDOC_Ek:
322 return(MDOC_Bk);
323 case MDOC_El:
324 return(MDOC_Bl);
325 case MDOC_Fc:
326 return(MDOC_Fo);
327 case MDOC_Oc:
328 return(MDOC_Oo);
329 case MDOC_Pc:
330 return(MDOC_Po);
331 case MDOC_Qc:
332 return(MDOC_Qo);
333 case MDOC_Re:
334 return(MDOC_Rs);
335 case MDOC_Sc:
336 return(MDOC_So);
337 case MDOC_Xc:
338 return(MDOC_Xo);
339 default:
340 return(tok);
341 }
342 /* NOTREACHED */
343 }
344
345 /*
346 * Rewinding to tok, how do we have to handle *p?
347 * REWIND_NONE: *p would delimit tok, but no tok scope is open
348 * inside *p, so there is no need to rewind anything at all.
349 * REWIND_THIS: *p matches tok, so rewind *p and nothing else.
350 * REWIND_MORE: *p is implicit, rewind it and keep searching for tok.
351 * REWIND_FORCE: *p is explicit, but tok is full, force rewinding *p.
352 * REWIND_LATER: *p is explicit and still open, postpone rewinding.
353 * REWIND_ERROR: No tok block is open at all.
354 */
355 static enum rew
356 rew_dohalt(enum mdoct tok, enum mdoc_type type,
357 const struct mdoc_node *p)
358 {
359
360 /*
361 * No matching token, no delimiting block, no broken block.
362 * This can happen when full implicit macros are called for
363 * the first time but try to rewind their previous
364 * instance anyway.
365 */
366 if (MDOC_ROOT == p->type)
367 return(MDOC_BLOCK == type &&
368 MDOC_EXPLICIT & mdoc_macros[tok].flags ?
369 REWIND_ERROR : REWIND_NONE);
370
371 /*
372 * When starting to rewind, skip plain text
373 * and nodes that have already been rewound.
374 */
375 if (MDOC_TEXT == p->type || MDOC_VALID & p->flags)
376 return(REWIND_MORE);
377
378 /*
379 * The easiest case: Found a matching token.
380 * This applies to both blocks and elements.
381 */
382 tok = rew_alt(tok);
383 if (tok == p->tok)
384 return(p->end ? REWIND_NONE :
385 type == p->type ? REWIND_THIS : REWIND_MORE);
386
387 /*
388 * While elements do require rewinding for themselves,
389 * they never affect rewinding of other nodes.
390 */
391 if (MDOC_ELEM == p->type)
392 return(REWIND_MORE);
393
394 /*
395 * Blocks delimited by our target token get REWIND_MORE.
396 * Blocks delimiting our target token get REWIND_NONE.
397 */
398 switch (tok) {
399 case MDOC_Bl:
400 if (MDOC_It == p->tok)
401 return(REWIND_MORE);
402 break;
403 case MDOC_It:
404 if (MDOC_BODY == p->type && MDOC_Bl == p->tok)
405 return(REWIND_NONE);
406 break;
407 /*
408 * XXX Badly nested block handling still fails badly
409 * when one block is breaking two blocks of the same type.
410 * This is an incomplete and extremely ugly workaround,
411 * required to let the OpenBSD tree build.
412 */
413 case MDOC_Oo:
414 if (MDOC_Op == p->tok)
415 return(REWIND_MORE);
416 break;
417 case MDOC_Nm:
418 return(REWIND_NONE);
419 case MDOC_Nd:
420 /* FALLTHROUGH */
421 case MDOC_Ss:
422 if (MDOC_BODY == p->type && MDOC_Sh == p->tok)
423 return(REWIND_NONE);
424 /* FALLTHROUGH */
425 case MDOC_Sh:
426 if (MDOC_ROOT == p->parent->type)
427 return(REWIND_THIS);
428 if (MDOC_Nd == p->tok || MDOC_Ss == p->tok ||
429 MDOC_Sh == p->tok)
430 return(REWIND_MORE);
431 break;
432 default:
433 break;
434 }
435
436 /*
437 * Default block rewinding rules.
438 * In particular, always skip block end markers,
439 * and let all blocks rewind Nm children.
440 */
441 if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok ||
442 (MDOC_BLOCK == p->type &&
443 ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)))
444 return(REWIND_MORE);
445
446 /*
447 * By default, closing out full blocks
448 * forces closing of broken explicit blocks,
449 * while closing out partial blocks
450 * allows delayed rewinding by default.
451 */
452 return (&blk_full == mdoc_macros[tok].fp ?
453 REWIND_FORCE : REWIND_LATER);
454 }
455
456 static int
457 rew_elem(struct mdoc *mdoc, enum mdoct tok)
458 {
459 struct mdoc_node *n;
460
461 n = mdoc->last;
462 if (MDOC_ELEM != n->type)
463 n = n->parent;
464 assert(MDOC_ELEM == n->type);
465 assert(tok == n->tok);
466
467 return(rew_last(mdoc, n));
468 }
469
470 /*
471 * We are trying to close a block identified by tok,
472 * but the child block *broken is still open.
473 * Thus, postpone closing the tok block
474 * until the rew_sub call closing *broken.
475 */
476 static int
477 make_pending(struct mdoc_node *broken, enum mdoct tok,
478 struct mdoc *mdoc, int line, int ppos)
479 {
480 struct mdoc_node *breaker;
481
482 /*
483 * Iterate backwards, searching for the block matching tok,
484 * that is, the block breaking the *broken block.
485 */
486 for (breaker = broken->parent; breaker; breaker = breaker->parent) {
487
488 /*
489 * If the *broken block had already been broken before
490 * and we encounter its breaker, make the tok block
491 * pending on the inner breaker.
492 * Graphically, "[A breaker=[B broken=[C->B B] tok=A] C]"
493 * becomes "[A broken=[B [C->B B] tok=A] C]"
494 * and finally "[A [B->A [C->B B] A] C]".
495 */
496 if (breaker == broken->pending) {
497 broken = breaker;
498 continue;
499 }
500
501 if (REWIND_THIS != rew_dohalt(tok, MDOC_BLOCK, breaker))
502 continue;
503 if (MDOC_BODY == broken->type)
504 broken = broken->parent;
505
506 /*
507 * Found the breaker.
508 * If another, outer breaker is already pending on
509 * the *broken block, we must not clobber the link
510 * to the outer breaker, but make it pending on the
511 * new, now inner breaker.
512 * Graphically, "[A breaker=[B broken=[C->A A] tok=B] C]"
513 * becomes "[A breaker=[B->A broken=[C A] tok=B] C]"
514 * and finally "[A [B->A [C->B A] B] C]".
515 */
516 if (broken->pending) {
517 struct mdoc_node *taker;
518
519 /*
520 * If the breaker had also been broken before,
521 * it cannot take on the outer breaker itself,
522 * but must hand it on to its own breakers.
523 * Graphically, this is the following situation:
524 * "[A [B breaker=[C->B B] broken=[D->A A] tok=C] D]"
525 * "[A taker=[B->A breaker=[C->B B] [D->C A] C] D]"
526 */
527 taker = breaker;
528 while (taker->pending)
529 taker = taker->pending;
530 taker->pending = broken->pending;
531 }
532 broken->pending = breaker;
533 mandoc_vmsg(MANDOCERR_BLK_NEST, mdoc->parse, line, ppos,
534 "%s breaks %s", mdoc_macronames[tok],
535 mdoc_macronames[broken->tok]);
536 return(1);
537 }
538
539 /*
540 * Found no matching block for tok.
541 * Are you trying to close a block that is not open?
542 */
543 return(0);
544 }
545
546 static int
547 rew_sub(enum mdoc_type t, struct mdoc *mdoc,
548 enum mdoct tok, int line, int ppos)
549 {
550 struct mdoc_node *n;
551
552 n = mdoc->last;
553 while (n) {
554 switch (rew_dohalt(tok, t, n)) {
555 case REWIND_NONE:
556 return(1);
557 case REWIND_THIS:
558 n->lastline = line -
559 (MDOC_NEWLINE & mdoc->flags &&
560 ! (MDOC_EXPLICIT & mdoc_macros[tok].flags));
561 break;
562 case REWIND_FORCE:
563 mandoc_vmsg(MANDOCERR_BLK_BROKEN, mdoc->parse,
564 line, ppos, "%s breaks %s",
565 mdoc_macronames[tok],
566 mdoc_macronames[n->tok]);
567 /* FALLTHROUGH */
568 case REWIND_MORE:
569 n->lastline = line -
570 (MDOC_NEWLINE & mdoc->flags ? 1 : 0);
571 n = n->parent;
572 continue;
573 case REWIND_LATER:
574 if (make_pending(n, tok, mdoc, line, ppos) ||
575 MDOC_BLOCK != t)
576 return(1);
577 /* FALLTHROUGH */
578 case REWIND_ERROR:
579 mandoc_msg(MANDOCERR_BLK_NOTOPEN,
580 mdoc->parse, line, ppos,
581 mdoc_macronames[tok]);
582 return(1);
583 }
584 break;
585 }
586
587 assert(n);
588 if ( ! rew_last(mdoc, n))
589 return(0);
590
591 /*
592 * The current block extends an enclosing block.
593 * Now that the current block ends, close the enclosing block, too.
594 */
595 while (NULL != (n = n->pending)) {
596 if ( ! rew_last(mdoc, n))
597 return(0);
598 if (MDOC_HEAD == n->type &&
599 ! mdoc_body_alloc(mdoc, n->line, n->pos, n->tok))
600 return(0);
601 }
602
603 return(1);
604 }
605
606 /*
607 * Allocate a word and check whether it's punctuation or not.
608 * Punctuation consists of those tokens found in mdoc_isdelim().
609 */
610 static int
611 dword(struct mdoc *mdoc, int line, int col, const char *p,
612 enum mdelim d, int may_append)
613 {
614
615 if (DELIM_MAX == d)
616 d = mdoc_isdelim(p);
617
618 if (may_append &&
619 ! ((MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF) & mdoc->flags) &&
620 DELIM_NONE == d && MDOC_TEXT == mdoc->last->type &&
621 DELIM_NONE == mdoc_isdelim(mdoc->last->string)) {
622 mdoc_word_append(mdoc, p);
623 return(1);
624 }
625
626 if ( ! mdoc_word_alloc(mdoc, line, col, p))
627 return(0);
628
629 /*
630 * If the word consists of a bare delimiter,
631 * flag the new node accordingly,
632 * unless doing so was vetoed by the invoking macro.
633 * Always clear the veto, it is only valid for one word.
634 */
635
636 if (d == DELIM_OPEN)
637 mdoc->last->flags |= MDOC_DELIMO;
638 else if (d == DELIM_CLOSE &&
639 ! (mdoc->flags & MDOC_NODELIMC) &&
640 mdoc->last->parent->tok != MDOC_Fd)
641 mdoc->last->flags |= MDOC_DELIMC;
642
643 mdoc->flags &= ~MDOC_NODELIMC;
644
645 return(1);
646 }
647
648 static int
649 append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
650 {
651 int la;
652 enum margserr ac;
653 char *p;
654
655 if ('\0' == buf[*pos])
656 return(1);
657
658 for (;;) {
659 la = *pos;
660 ac = mdoc_zargs(mdoc, line, pos, buf, &p);
661
662 if (ARGS_ERROR == ac)
663 return(0);
664 else if (ARGS_EOLN == ac)
665 break;
666
667 dword(mdoc, line, la, p, DELIM_MAX, 1);
668
669 /*
670 * If we encounter end-of-sentence symbols, then trigger
671 * the double-space.
672 *
673 * XXX: it's easy to allow this to propagate outward to
674 * the last symbol, such that `. )' will cause the
675 * correct double-spacing. However, (1) groff isn't
676 * smart enough to do this and (2) it would require
677 * knowing which symbols break this behaviour, for
678 * example, `. ;' shouldn't propagate the double-space.
679 */
680 if (mandoc_eos(p, strlen(p)))
681 mdoc->last->flags |= MDOC_EOS;
682 }
683
684 return(1);
685 }
686
687 /*
688 * Close out block partial/full explicit.
689 */
690 static int
691 blk_exp_close(MACRO_PROT_ARGS)
692 {
693 struct mdoc_node *body; /* Our own body. */
694 struct mdoc_node *later; /* A sub-block starting later. */
695 struct mdoc_node *n; /* For searching backwards. */
696
697 int j, lastarg, maxargs, flushed, nl;
698 enum margserr ac;
699 enum mdoct atok, ntok;
700 char *p;
701
702 nl = MDOC_NEWLINE & mdoc->flags;
703
704 switch (tok) {
705 case MDOC_Ec:
706 maxargs = 1;
707 break;
708 case MDOC_Ek:
709 mdoc->flags &= ~MDOC_KEEP;
710 default:
711 maxargs = 0;
712 break;
713 }
714
715 /*
716 * Search backwards for beginnings of blocks,
717 * both of our own and of pending sub-blocks.
718 */
719 atok = rew_alt(tok);
720 body = later = NULL;
721 for (n = mdoc->last; n; n = n->parent) {
722 if (MDOC_VALID & n->flags)
723 continue;
724
725 /* Remember the start of our own body. */
726 if (MDOC_BODY == n->type && atok == n->tok) {
727 if (ENDBODY_NOT == n->end)
728 body = n;
729 continue;
730 }
731
732 if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok)
733 continue;
734 if (atok == n->tok) {
735 assert(body);
736
737 /*
738 * Found the start of our own block.
739 * When there is no pending sub block,
740 * just proceed to closing out.
741 */
742 if (NULL == later)
743 break;
744
745 /*
746 * When there is a pending sub block,
747 * postpone closing out the current block
748 * until the rew_sub() closing out the sub-block.
749 */
750 make_pending(later, tok, mdoc, line, ppos);
751
752 /*
753 * Mark the place where the formatting - but not
754 * the scope - of the current block ends.
755 */
756 if ( ! mdoc_endbody_alloc(mdoc, line, ppos,
757 atok, body, ENDBODY_SPACE))
758 return(0);
759 break;
760 }
761
762 /*
763 * When finding an open sub block, remember the last
764 * open explicit block, or, in case there are only
765 * implicit ones, the first open implicit block.
766 */
767 if (later &&
768 MDOC_EXPLICIT & mdoc_macros[later->tok].flags)
769 continue;
770 if (MDOC_It != n->tok)
771 later = n;
772 }
773
774 if ( ! (MDOC_PARSED & mdoc_macros[tok].flags)) {
775 if ('\0' != buf[*pos])
776 mandoc_vmsg(MANDOCERR_ARG_SKIP,
777 mdoc->parse, line, ppos,
778 "%s %s", mdoc_macronames[tok],
779 buf + *pos);
780 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
781 return(0);
782 return(rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos));
783 }
784
785 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
786 return(0);
787
788 if (NULL == later && maxargs > 0)
789 if ( ! mdoc_tail_alloc(mdoc, line, ppos, rew_alt(tok)))
790 return(0);
791
792 for (flushed = j = 0; ; j++) {
793 lastarg = *pos;
794
795 if (j == maxargs && ! flushed) {
796 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
797 return(0);
798 flushed = 1;
799 }
800
801 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
802
803 if (ARGS_ERROR == ac)
804 return(0);
805 if (ARGS_PUNCT == ac)
806 break;
807 if (ARGS_EOLN == ac)
808 break;
809
810 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
811
812 if (MDOC_MAX == ntok) {
813 if ( ! dword(mdoc, line, lastarg, p, DELIM_MAX,
814 MDOC_JOIN & mdoc_macros[tok].flags))
815 return(0);
816 continue;
817 }
818
819 if ( ! flushed) {
820 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
821 return(0);
822 flushed = 1;
823 }
824
825 mdoc->flags &= ~MDOC_NEWLINE;
826
827 if ( ! mdoc_macro(mdoc, ntok, line, lastarg, pos, buf))
828 return(0);
829 break;
830 }
831
832 if ( ! flushed && ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
833 return(0);
834
835 if ( ! nl)
836 return(1);
837 return(append_delims(mdoc, line, pos, buf));
838 }
839
840 static int
841 in_line(MACRO_PROT_ARGS)
842 {
843 int la, scope, cnt, firstarg, mayopen, nc, nl;
844 enum margverr av;
845 enum mdoct ntok;
846 enum margserr ac;
847 enum mdelim d;
848 struct mdoc_arg *arg;
849 char *p;
850
851 nl = MDOC_NEWLINE & mdoc->flags;
852
853 /*
854 * Whether we allow ignored elements (those without content,
855 * usually because of reserved words) to squeak by.
856 */
857
858 switch (tok) {
859 case MDOC_An:
860 /* FALLTHROUGH */
861 case MDOC_Ar:
862 /* FALLTHROUGH */
863 case MDOC_Fl:
864 /* FALLTHROUGH */
865 case MDOC_Mt:
866 /* FALLTHROUGH */
867 case MDOC_Nm:
868 /* FALLTHROUGH */
869 case MDOC_Pa:
870 nc = 1;
871 break;
872 default:
873 nc = 0;
874 break;
875 }
876
877 for (arg = NULL;; ) {
878 la = *pos;
879 av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
880
881 if (ARGV_WORD == av) {
882 *pos = la;
883 break;
884 }
885 if (ARGV_EOLN == av)
886 break;
887 if (ARGV_ARG == av)
888 continue;
889
890 mdoc_argv_free(arg);
891 return(0);
892 }
893
894 d = DELIM_NONE;
895 firstarg = 1;
896 mayopen = 1;
897 for (cnt = scope = 0;; ) {
898 la = *pos;
899 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
900
901 if (ac == ARGS_ERROR)
902 return(0);
903
904 /*
905 * At the end of a macro line,
906 * opening delimiters do not suppress spacing.
907 */
908
909 if (ac == ARGS_EOLN) {
910 if (d == DELIM_OPEN)
911 mdoc->last->flags &= ~MDOC_DELIMO;
912 break;
913 }
914
915 /*
916 * The rest of the macro line is only punctuation,
917 * to be handled by append_delims().
918 * If there were no other arguments,
919 * do not allow the first one to suppress spacing,
920 * even if it turns out to be a closing one.
921 */
922
923 if (ac == ARGS_PUNCT) {
924 if (cnt == 0 && nc == 0)
925 mdoc->flags |= MDOC_NODELIMC;
926 break;
927 }
928
929 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
930
931 /*
932 * In this case, we've located a submacro and must
933 * execute it. Close out scope, if open. If no
934 * elements have been generated, either create one (nc)
935 * or raise a warning.
936 */
937
938 if (MDOC_MAX != ntok) {
939 if (scope && ! rew_elem(mdoc, tok))
940 return(0);
941 if (nc && 0 == cnt) {
942 if ( ! mdoc_elem_alloc(mdoc,
943 line, ppos, tok, arg))
944 return(0);
945 if ( ! rew_last(mdoc, mdoc->last))
946 return(0);
947 } else if ( ! nc && 0 == cnt) {
948 mdoc_argv_free(arg);
949 mandoc_msg(MANDOCERR_MACRO_EMPTY,
950 mdoc->parse, line, ppos,
951 mdoc_macronames[tok]);
952 }
953
954 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
955 return(0);
956 if ( ! nl)
957 return(1);
958 return(append_delims(mdoc, line, pos, buf));
959 }
960
961 /*
962 * Non-quote-enclosed punctuation. Set up our scope, if
963 * a word; rewind the scope, if a delimiter; then append
964 * the word.
965 */
966
967 d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p);
968
969 if (DELIM_NONE != d) {
970 /*
971 * If we encounter closing punctuation, no word
972 * has been emitted, no scope is open, and we're
973 * allowed to have an empty element, then start
974 * a new scope.
975 */
976 if ((d == DELIM_CLOSE ||
977 (d == DELIM_MIDDLE && tok == MDOC_Fl)) &&
978 !cnt && !scope && nc && mayopen) {
979 if ( ! mdoc_elem_alloc(mdoc,
980 line, ppos, tok, arg))
981 return(0);
982 scope = 1;
983 cnt++;
984 if (MDOC_Nm == tok)
985 mayopen = 0;
986 }
987 /*
988 * Close out our scope, if one is open, before
989 * any punctuation.
990 */
991 if (scope && ! rew_elem(mdoc, tok))
992 return(0);
993 scope = 0;
994 } else if (mayopen && !scope) {
995 if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
996 return(0);
997 scope = 1;
998 cnt++;
999 }
1000
1001 if ( ! dword(mdoc, line, la, p, d,
1002 MDOC_JOIN & mdoc_macros[tok].flags))
1003 return(0);
1004
1005 /*
1006 * If the first argument is a closing delimiter,
1007 * do not suppress spacing before it.
1008 */
1009
1010 if (firstarg && d == DELIM_CLOSE && !nc)
1011 mdoc->last->flags &= ~MDOC_DELIMC;
1012 firstarg = 0;
1013
1014 /*
1015 * `Fl' macros have their scope re-opened with each new
1016 * word so that the `-' can be added to each one without
1017 * having to parse out spaces.
1018 */
1019 if (scope && MDOC_Fl == tok) {
1020 if ( ! rew_elem(mdoc, tok))
1021 return(0);
1022 scope = 0;
1023 }
1024 }
1025
1026 if (scope && ! rew_elem(mdoc, tok))
1027 return(0);
1028
1029 /*
1030 * If no elements have been collected and we're allowed to have
1031 * empties (nc), open a scope and close it out. Otherwise,
1032 * raise a warning.
1033 */
1034
1035 if (nc && 0 == cnt) {
1036 if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1037 return(0);
1038 if ( ! rew_last(mdoc, mdoc->last))
1039 return(0);
1040 } else if ( ! nc && 0 == cnt) {
1041 mdoc_argv_free(arg);
1042 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
1043 line, ppos, mdoc_macronames[tok]);
1044 }
1045
1046 if ( ! nl)
1047 return(1);
1048 return(append_delims(mdoc, line, pos, buf));
1049 }
1050
1051 static int
1052 blk_full(MACRO_PROT_ARGS)
1053 {
1054 int la, nl, nparsed;
1055 struct mdoc_arg *arg;
1056 struct mdoc_node *head; /* save of head macro */
1057 struct mdoc_node *body; /* save of body macro */
1058 struct mdoc_node *n;
1059 enum mdoc_type mtt;
1060 enum mdoct ntok;
1061 enum margserr ac, lac;
1062 enum margverr av;
1063 char *p;
1064
1065 nl = MDOC_NEWLINE & mdoc->flags;
1066
1067 /* Skip items outside lists. */
1068
1069 if (tok == MDOC_It) {
1070 for (n = mdoc->last; n; n = n->parent)
1071 if (n->tok == MDOC_Bl &&
1072 ! (n->flags & MDOC_VALID))
1073 break;
1074 if (n == NULL) {
1075 mandoc_vmsg(MANDOCERR_IT_STRAY, mdoc->parse,
1076 line, ppos, "It %s", buf + *pos);
1077 if ( ! mdoc_elem_alloc(mdoc, line, ppos,
1078 MDOC_br, NULL))
1079 return(0);
1080 return(rew_elem(mdoc, MDOC_br));
1081 }
1082 }
1083
1084 /* Close out prior implicit scope. */
1085
1086 if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
1087 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1088 return(0);
1089 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1090 return(0);
1091 }
1092
1093 /*
1094 * This routine accommodates implicitly- and explicitly-scoped
1095 * macro openings. Implicit ones first close out prior scope
1096 * (seen above). Delay opening the head until necessary to
1097 * allow leading punctuation to print. Special consideration
1098 * for `It -column', which has phrase-part syntax instead of
1099 * regular child nodes.
1100 */
1101
1102 for (arg = NULL;; ) {
1103 la = *pos;
1104 av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1105
1106 if (ARGV_WORD == av) {
1107 *pos = la;
1108 break;
1109 }
1110
1111 if (ARGV_EOLN == av)
1112 break;
1113 if (ARGV_ARG == av)
1114 continue;
1115
1116 mdoc_argv_free(arg);
1117 return(0);
1118 }
1119
1120 if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg))
1121 return(0);
1122
1123 head = body = NULL;
1124
1125 /*
1126 * Exception: Heads of `It' macros in `-diag' lists are not
1127 * parsed, even though `It' macros in general are parsed.
1128 */
1129 nparsed = MDOC_It == tok &&
1130 MDOC_Bl == mdoc->last->parent->tok &&
1131 LIST_diag == mdoc->last->parent->norm->Bl.type;
1132
1133 /*
1134 * The `Nd' macro has all arguments in its body: it's a hybrid
1135 * of block partial-explicit and full-implicit. Stupid.
1136 */
1137
1138 if (MDOC_Nd == tok) {
1139 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1140 return(0);
1141 head = mdoc->last;
1142 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1143 return(0);
1144 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1145 return(0);
1146 body = mdoc->last;
1147 }
1148
1149 if (MDOC_Bk == tok)
1150 mdoc->flags |= MDOC_KEEP;
1151
1152 ac = ARGS_ERROR;
1153
1154 for ( ; ; ) {
1155 la = *pos;
1156 /* Initialise last-phrase-type with ARGS_PEND. */
1157 lac = ARGS_ERROR == ac ? ARGS_PEND : ac;
1158 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1159
1160 if (ARGS_PUNCT == ac)
1161 break;
1162
1163 if (ARGS_ERROR == ac)
1164 return(0);
1165
1166 if (ARGS_EOLN == ac) {
1167 if (ARGS_PPHRASE != lac && ARGS_PHRASE != lac)
1168 break;
1169 /*
1170 * This is necessary: if the last token on a
1171 * line is a `Ta' or tab, then we'll get
1172 * ARGS_EOLN, so we must be smart enough to
1173 * reopen our scope if the last parse was a
1174 * phrase or partial phrase.
1175 */
1176 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1177 return(0);
1178 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1179 return(0);
1180 body = mdoc->last;
1181 break;
1182 }
1183
1184 /*
1185 * Emit leading punctuation (i.e., punctuation before
1186 * the MDOC_HEAD) for non-phrase types.
1187 */
1188
1189 if (NULL == head &&
1190 ARGS_PEND != ac &&
1191 ARGS_PHRASE != ac &&
1192 ARGS_PPHRASE != ac &&
1193 ARGS_QWORD != ac &&
1194 DELIM_OPEN == mdoc_isdelim(p)) {
1195 if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1196 return(0);
1197 continue;
1198 }
1199
1200 /* Open a head if one hasn't been opened. */
1201
1202 if (NULL == head) {
1203 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1204 return(0);
1205 head = mdoc->last;
1206 }
1207
1208 if (ARGS_PHRASE == ac ||
1209 ARGS_PEND == ac ||
1210 ARGS_PPHRASE == ac) {
1211 /*
1212 * If we haven't opened a body yet, rewind the
1213 * head; if we have, rewind that instead.
1214 */
1215
1216 mtt = body ? MDOC_BODY : MDOC_HEAD;
1217 if ( ! rew_sub(mtt, mdoc, tok, line, ppos))
1218 return(0);
1219
1220 /* Then allocate our body context. */
1221
1222 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1223 return(0);
1224 body = mdoc->last;
1225
1226 /*
1227 * Process phrases: set whether we're in a
1228 * partial-phrase (this effects line handling)
1229 * then call down into the phrase parser.
1230 */
1231
1232 if (ARGS_PPHRASE == ac)
1233 mdoc->flags |= MDOC_PPHRASE;
1234 if (ARGS_PEND == ac && ARGS_PPHRASE == lac)
1235 mdoc->flags |= MDOC_PPHRASE;
1236
1237 if ( ! phrase(mdoc, line, la, buf))
1238 return(0);
1239
1240 mdoc->flags &= ~MDOC_PPHRASE;
1241 continue;
1242 }
1243
1244 ntok = nparsed || ARGS_QWORD == ac ?
1245 MDOC_MAX : lookup(tok, p);
1246
1247 if (MDOC_MAX == ntok) {
1248 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1249 MDOC_JOIN & mdoc_macros[tok].flags))
1250 return(0);
1251 continue;
1252 }
1253
1254 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1255 return(0);
1256 break;
1257 }
1258
1259 if (NULL == head) {
1260 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1261 return(0);
1262 head = mdoc->last;
1263 }
1264
1265 if (nl && ! append_delims(mdoc, line, pos, buf))
1266 return(0);
1267
1268 /* If we've already opened our body, exit now. */
1269
1270 if (NULL != body)
1271 goto out;
1272
1273 /*
1274 * If there is an open (i.e., unvalidated) sub-block requiring
1275 * explicit close-out, postpone switching the current block from
1276 * head to body until the rew_sub() call closing out that
1277 * sub-block.
1278 */
1279 for (n = mdoc->last; n && n != head; n = n->parent) {
1280 if (MDOC_BLOCK == n->type &&
1281 MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1282 ! (MDOC_VALID & n->flags)) {
1283 n->pending = head;
1284 return(1);
1285 }
1286 }
1287
1288 /* Close out scopes to remain in a consistent state. */
1289
1290 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1291 return(0);
1292 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1293 return(0);
1294
1295 out:
1296 if ( ! (MDOC_FREECOL & mdoc->flags))
1297 return(1);
1298
1299 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1300 return(0);
1301 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1302 return(0);
1303
1304 mdoc->flags &= ~MDOC_FREECOL;
1305 return(1);
1306 }
1307
1308 static int
1309 blk_part_imp(MACRO_PROT_ARGS)
1310 {
1311 int la, nl;
1312 enum mdoct ntok;
1313 enum margserr ac;
1314 char *p;
1315 struct mdoc_node *blk; /* saved block context */
1316 struct mdoc_node *body; /* saved body context */
1317 struct mdoc_node *n;
1318
1319 nl = MDOC_NEWLINE & mdoc->flags;
1320
1321 /*
1322 * A macro that spans to the end of the line. This is generally
1323 * (but not necessarily) called as the first macro. The block
1324 * has a head as the immediate child, which is always empty,
1325 * followed by zero or more opening punctuation nodes, then the
1326 * body (which may be empty, depending on the macro), then zero
1327 * or more closing punctuation nodes.
1328 */
1329
1330 if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
1331 return(0);
1332
1333 blk = mdoc->last;
1334
1335 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1336 return(0);
1337 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1338 return(0);
1339
1340 /*
1341 * Open the body scope "on-demand", that is, after we've
1342 * processed all our the leading delimiters (open parenthesis,
1343 * etc.).
1344 */
1345
1346 for (body = NULL; ; ) {
1347 la = *pos;
1348 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1349
1350 if (ARGS_ERROR == ac)
1351 return(0);
1352 if (ARGS_EOLN == ac)
1353 break;
1354 if (ARGS_PUNCT == ac)
1355 break;
1356
1357 if (NULL == body && ARGS_QWORD != ac &&
1358 DELIM_OPEN == mdoc_isdelim(p)) {
1359 if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1360 return(0);
1361 continue;
1362 }
1363
1364 if (NULL == body) {
1365 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1366 return(0);
1367 body = mdoc->last;
1368 }
1369
1370 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1371
1372 if (MDOC_MAX == ntok) {
1373 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1374 MDOC_JOIN & mdoc_macros[tok].flags))
1375 return(0);
1376 continue;
1377 }
1378
1379 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1380 return(0);
1381 break;
1382 }
1383
1384 /* Clean-ups to leave in a consistent state. */
1385
1386 if (NULL == body) {
1387 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1388 return(0);
1389 body = mdoc->last;
1390 }
1391
1392 /*
1393 * If there is an open sub-block requiring explicit close-out,
1394 * postpone closing out the current block
1395 * until the rew_sub() call closing out the sub-block.
1396 */
1397 for (n = mdoc->last; n && n != body && n != blk->parent;
1398 n = n->parent) {
1399 if (MDOC_BLOCK == n->type &&
1400 MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1401 ! (MDOC_VALID & n->flags)) {
1402 make_pending(n, tok, mdoc, line, ppos);
1403 if ( ! mdoc_endbody_alloc(mdoc, line, ppos,
1404 tok, body, ENDBODY_NOSPACE))
1405 return(0);
1406 return(1);
1407 }
1408 }
1409 assert(n == body);
1410
1411 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1412 return(0);
1413
1414 /* Standard appending of delimiters. */
1415
1416 if (nl && ! append_delims(mdoc, line, pos, buf))
1417 return(0);
1418
1419 /* Rewind scope, if applicable. */
1420
1421 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1422 return(0);
1423
1424 /* Move trailing .Ns out of scope. */
1425
1426 for (n = body->child; n && n->next; n = n->next)
1427 /* Do nothing. */ ;
1428 if (n && MDOC_Ns == n->tok)
1429 mdoc_node_relink(mdoc, n);
1430
1431 return(1);
1432 }
1433
1434 static int
1435 blk_part_exp(MACRO_PROT_ARGS)
1436 {
1437 int la, nl;
1438 enum margserr ac;
1439 struct mdoc_node *head; /* keep track of head */
1440 struct mdoc_node *body; /* keep track of body */
1441 char *p;
1442 enum mdoct ntok;
1443
1444 nl = MDOC_NEWLINE & mdoc->flags;
1445
1446 /*
1447 * The opening of an explicit macro having zero or more leading
1448 * punctuation nodes; a head with optional single element (the
1449 * case of `Eo'); and a body that may be empty.
1450 */
1451
1452 if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
1453 return(0);
1454
1455 for (head = body = NULL; ; ) {
1456 la = *pos;
1457 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1458
1459 if (ARGS_ERROR == ac)
1460 return(0);
1461 if (ARGS_PUNCT == ac)
1462 break;
1463 if (ARGS_EOLN == ac)
1464 break;
1465
1466 /* Flush out leading punctuation. */
1467
1468 if (NULL == head && ARGS_QWORD != ac &&
1469 DELIM_OPEN == mdoc_isdelim(p)) {
1470 assert(NULL == body);
1471 if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1472 return(0);
1473 continue;
1474 }
1475
1476 if (NULL == head) {
1477 assert(NULL == body);
1478 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1479 return(0);
1480 head = mdoc->last;
1481 }
1482
1483 /*
1484 * `Eo' gobbles any data into the head, but most other
1485 * macros just immediately close out and begin the body.
1486 */
1487
1488 if (NULL == body) {
1489 assert(head);
1490 /* No check whether it's a macro! */
1491 if (MDOC_Eo == tok)
1492 if ( ! dword(mdoc, line, la, p, DELIM_MAX, 0))
1493 return(0);
1494
1495 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1496 return(0);
1497 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1498 return(0);
1499 body = mdoc->last;
1500
1501 if (MDOC_Eo == tok)
1502 continue;
1503 }
1504
1505 assert(NULL != head && NULL != body);
1506
1507 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1508
1509 if (MDOC_MAX == ntok) {
1510 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1511 MDOC_JOIN & mdoc_macros[tok].flags))
1512 return(0);
1513 continue;
1514 }
1515
1516 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1517 return(0);
1518 break;
1519 }
1520
1521 /* Clean-up to leave in a consistent state. */
1522
1523 if (NULL == head)
1524 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1525 return(0);
1526
1527 if (NULL == body) {
1528 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1529 return(0);
1530 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1531 return(0);
1532 }
1533
1534 /* Standard appending of delimiters. */
1535
1536 if ( ! nl)
1537 return(1);
1538 return(append_delims(mdoc, line, pos, buf));
1539 }
1540
1541 static int
1542 in_line_argn(MACRO_PROT_ARGS)
1543 {
1544 int la, flushed, j, maxargs, nl;
1545 enum margserr ac;
1546 enum margverr av;
1547 struct mdoc_arg *arg;
1548 char *p;
1549 enum mdoct ntok;
1550
1551 nl = MDOC_NEWLINE & mdoc->flags;
1552
1553 /*
1554 * A line macro that has a fixed number of arguments (maxargs).
1555 * Only open the scope once the first non-leading-punctuation is
1556 * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1557 * keep it open until the maximum number of arguments are
1558 * exhausted.
1559 */
1560
1561 switch (tok) {
1562 case MDOC_Ap:
1563 /* FALLTHROUGH */
1564 case MDOC_Ns:
1565 /* FALLTHROUGH */
1566 case MDOC_Ux:
1567 maxargs = 0;
1568 break;
1569 case MDOC_Bx:
1570 /* FALLTHROUGH */
1571 case MDOC_Es:
1572 /* FALLTHROUGH */
1573 case MDOC_Xr:
1574 maxargs = 2;
1575 break;
1576 default:
1577 maxargs = 1;
1578 break;
1579 }
1580
1581 for (arg = NULL; ; ) {
1582 la = *pos;
1583 av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1584
1585 if (ARGV_WORD == av) {
1586 *pos = la;
1587 break;
1588 }
1589
1590 if (ARGV_EOLN == av)
1591 break;
1592 if (ARGV_ARG == av)
1593 continue;
1594
1595 mdoc_argv_free(arg);
1596 return(0);
1597 }
1598
1599 for (flushed = j = 0; ; ) {
1600 la = *pos;
1601 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1602
1603 if (ARGS_ERROR == ac)
1604 return(0);
1605 if (ARGS_PUNCT == ac)
1606 break;
1607 if (ARGS_EOLN == ac)
1608 break;
1609
1610 if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1611 ARGS_QWORD != ac && 0 == j &&
1612 DELIM_OPEN == mdoc_isdelim(p)) {
1613 if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1614 return(0);
1615 continue;
1616 } else if (0 == j)
1617 if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1618 return(0);
1619
1620 if (j == maxargs && ! flushed) {
1621 if ( ! rew_elem(mdoc, tok))
1622 return(0);
1623 flushed = 1;
1624 }
1625
1626 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1627
1628 if (MDOC_MAX != ntok) {
1629 if ( ! flushed && ! rew_elem(mdoc, tok))
1630 return(0);
1631 flushed = 1;
1632 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1633 return(0);
1634 j++;
1635 break;
1636 }
1637
1638 if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1639 ARGS_QWORD != ac &&
1640 ! flushed &&
1641 DELIM_NONE != mdoc_isdelim(p)) {
1642 if ( ! rew_elem(mdoc, tok))
1643 return(0);
1644 flushed = 1;
1645 }
1646
1647 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1648 MDOC_JOIN & mdoc_macros[tok].flags))
1649 return(0);
1650 j++;
1651 }
1652
1653 if (0 == j && ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1654 return(0);
1655
1656 /* Close out in a consistent state. */
1657
1658 if ( ! flushed && ! rew_elem(mdoc, tok))
1659 return(0);
1660 if ( ! nl)
1661 return(1);
1662 return(append_delims(mdoc, line, pos, buf));
1663 }
1664
1665 static int
1666 in_line_eoln(MACRO_PROT_ARGS)
1667 {
1668 int la;
1669 enum margserr ac;
1670 enum margverr av;
1671 struct mdoc_arg *arg;
1672 char *p;
1673 enum mdoct ntok;
1674
1675 assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
1676
1677 if (tok == MDOC_Pp)
1678 rew_sub(MDOC_BLOCK, mdoc, MDOC_Nm, line, ppos);
1679
1680 /* Parse macro arguments. */
1681
1682 for (arg = NULL; ; ) {
1683 la = *pos;
1684 av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1685
1686 if (ARGV_WORD == av) {
1687 *pos = la;
1688 break;
1689 }
1690 if (ARGV_EOLN == av)
1691 break;
1692 if (ARGV_ARG == av)
1693 continue;
1694
1695 mdoc_argv_free(arg);
1696 return(0);
1697 }
1698
1699 /* Open element scope. */
1700
1701 if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1702 return(0);
1703
1704 /* Parse argument terms. */
1705
1706 for (;;) {
1707 la = *pos;
1708 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1709
1710 if (ARGS_ERROR == ac)
1711 return(0);
1712 if (ARGS_EOLN == ac)
1713 break;
1714
1715 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1716
1717 if (MDOC_MAX == ntok) {
1718 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1719 MDOC_JOIN & mdoc_macros[tok].flags))
1720 return(0);
1721 continue;
1722 }
1723
1724 if ( ! rew_elem(mdoc, tok))
1725 return(0);
1726 return(mdoc_macro(mdoc, ntok, line, la, pos, buf));
1727 }
1728
1729 /* Close out (no delimiters). */
1730
1731 return(rew_elem(mdoc, tok));
1732 }
1733
1734 static int
1735 ctx_synopsis(MACRO_PROT_ARGS)
1736 {
1737 int nl;
1738
1739 nl = MDOC_NEWLINE & mdoc->flags;
1740
1741 /* If we're not in the SYNOPSIS, go straight to in-line. */
1742 if ( ! (MDOC_SYNOPSIS & mdoc->flags))
1743 return(in_line(mdoc, tok, line, ppos, pos, buf));
1744
1745 /* If we're a nested call, same place. */
1746 if ( ! nl)
1747 return(in_line(mdoc, tok, line, ppos, pos, buf));
1748
1749 /*
1750 * XXX: this will open a block scope; however, if later we end
1751 * up formatting the block scope, then child nodes will inherit
1752 * the formatting. Be careful.
1753 */
1754 if (MDOC_Nm == tok)
1755 return(blk_full(mdoc, tok, line, ppos, pos, buf));
1756 assert(MDOC_Vt == tok);
1757 return(blk_part_imp(mdoc, tok, line, ppos, pos, buf));
1758 }
1759
1760 /*
1761 * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1762 * They're unusual because they're basically free-form text until a
1763 * macro is encountered.
1764 */
1765 static int
1766 phrase(struct mdoc *mdoc, int line, int ppos, char *buf)
1767 {
1768 int la, pos;
1769 enum margserr ac;
1770 enum mdoct ntok;
1771 char *p;
1772
1773 for (pos = ppos; ; ) {
1774 la = pos;
1775
1776 ac = mdoc_zargs(mdoc, line, &pos, buf, &p);
1777
1778 if (ARGS_ERROR == ac)
1779 return(0);
1780 if (ARGS_EOLN == ac)
1781 break;
1782
1783 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
1784
1785 if (MDOC_MAX == ntok) {
1786 if ( ! dword(mdoc, line, la, p, DELIM_MAX, 1))
1787 return(0);
1788 continue;
1789 }
1790
1791 if ( ! mdoc_macro(mdoc, ntok, line, la, &pos, buf))
1792 return(0);
1793 return(append_delims(mdoc, line, &pos, buf));
1794 }
1795
1796 return(1);
1797 }
1798
1799 static int
1800 phrase_ta(MACRO_PROT_ARGS)
1801 {
1802 struct mdoc_node *n;
1803 int la;
1804 enum mdoct ntok;
1805 enum margserr ac;
1806 char *p;
1807
1808 /* Make sure we are in a column list or ignore this macro. */
1809 n = mdoc->last;
1810 while (NULL != n && MDOC_Bl != n->tok)
1811 n = n->parent;
1812 if (NULL == n || LIST_column != n->norm->Bl.type) {
1813 mandoc_msg(MANDOCERR_TA_STRAY, mdoc->parse,
1814 line, ppos, "Ta");
1815 return(1);
1816 }
1817
1818 /* Advance to the next column. */
1819 if ( ! rew_sub(MDOC_BODY, mdoc, MDOC_It, line, ppos))
1820 return(0);
1821 if ( ! mdoc_body_alloc(mdoc, line, ppos, MDOC_It))
1822 return(0);
1823
1824 for (;;) {
1825 la = *pos;
1826 ac = mdoc_zargs(mdoc, line, pos, buf, &p);
1827
1828 if (ARGS_ERROR == ac)
1829 return(0);
1830 if (ARGS_EOLN == ac)
1831 break;
1832
1833 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
1834
1835 if (MDOC_MAX == ntok) {
1836 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1837 MDOC_JOIN & mdoc_macros[tok].flags))
1838 return(0);
1839 continue;
1840 }
1841
1842 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1843 return(0);
1844 return(append_delims(mdoc, line, pos, buf));
1845 }
1846
1847 return(1);
1848 }
A git conversion mirror of mandoc.bsd.lv