]> 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
Clean up messages regarding excess arguments:
[mandoc.git] / mdoc_macro.c
1 /* $Id: mdoc_macro.c,v 1.136 2014/07/04 16:12:08 schwarze Exp $ */
2 /*
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012, 2013 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 #ifdef HAVE_CONFIG_H
19 #include "config.h"
20 #endif
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_argn, MDOC_CALLABLE | MDOC_PARSED |
151 MDOC_IGNDELIM | MDOC_JOIN }, /* No */
152 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED |
153 MDOC_IGNDELIM | MDOC_JOIN }, /* Ns */
154 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
155 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
156 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
157 MDOC_EXPLICIT | MDOC_JOIN }, /* Pc */
158 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
159 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
160 MDOC_EXPLICIT | MDOC_JOIN }, /* Po */
161 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Pq */
162 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
163 MDOC_EXPLICIT | MDOC_JOIN }, /* Qc */
164 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ql */
165 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
166 MDOC_EXPLICIT | MDOC_JOIN }, /* Qo */
167 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Qq */
168 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Re */
169 { blk_full, MDOC_EXPLICIT }, /* Rs */
170 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
171 MDOC_EXPLICIT | MDOC_JOIN }, /* Sc */
172 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
173 MDOC_EXPLICIT | MDOC_JOIN }, /* So */
174 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sq */
175 { in_line_eoln, 0 }, /* Sm */
176 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sx */
177 { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sy */
178 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
179 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ux */
180 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
181 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
182 { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
183 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
184 MDOC_EXPLICIT | MDOC_JOIN }, /* Fc */
185 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
186 MDOC_EXPLICIT | MDOC_JOIN }, /* Oo */
187 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
188 MDOC_EXPLICIT | MDOC_JOIN }, /* Oc */
189 { blk_full, MDOC_EXPLICIT }, /* Bk */
190 { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ek */
191 { in_line_eoln, 0 }, /* Bt */
192 { in_line_eoln, 0 }, /* Hf */
193 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fr */
194 { in_line_eoln, 0 }, /* Ud */
195 { in_line, 0 }, /* Lb */
196 { in_line_eoln, 0 }, /* Lp */
197 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
198 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
199 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Brq */
200 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
201 MDOC_EXPLICIT | MDOC_JOIN }, /* Bro */
202 { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
203 MDOC_EXPLICIT | MDOC_JOIN }, /* Brc */
204 { in_line_eoln, MDOC_JOIN }, /* %C */
205 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Es */
206 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* En */
207 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
208 { in_line_eoln, MDOC_JOIN }, /* %Q */
209 { in_line_eoln, 0 }, /* br */
210 { in_line_eoln, 0 }, /* sp */
211 { in_line_eoln, 0 }, /* %U */
212 { phrase_ta, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ta */
213 { in_line_eoln, 0 }, /* ll */
214 };
215
216 const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
217
218
219 /*
220 * This is called at the end of parsing. It must traverse up the tree,
221 * closing out open [implicit] scopes. Obviously, open explicit scopes
222 * are errors.
223 */
224 int
225 mdoc_macroend(struct mdoc *mdoc)
226 {
227 struct mdoc_node *n;
228
229 /* Scan for open explicit scopes. */
230
231 n = MDOC_VALID & mdoc->last->flags ?
232 mdoc->last->parent : mdoc->last;
233
234 for ( ; n; n = n->parent)
235 if (MDOC_BLOCK == n->type &&
236 MDOC_EXPLICIT & mdoc_macros[n->tok].flags)
237 mdoc_nmsg(mdoc, n, MANDOCERR_SCOPEEXIT);
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_Nd == p->tok || MDOC_Ss == p->tok ||
427 MDOC_Sh == p->tok)
428 return(REWIND_MORE);
429 break;
430 default:
431 break;
432 }
433
434 /*
435 * Default block rewinding rules.
436 * In particular, always skip block end markers,
437 * and let all blocks rewind Nm children.
438 */
439 if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok ||
440 (MDOC_BLOCK == p->type &&
441 ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)))
442 return(REWIND_MORE);
443
444 /*
445 * By default, closing out full blocks
446 * forces closing of broken explicit blocks,
447 * while closing out partial blocks
448 * allows delayed rewinding by default.
449 */
450 return (&blk_full == mdoc_macros[tok].fp ?
451 REWIND_FORCE : REWIND_LATER);
452 }
453
454 static int
455 rew_elem(struct mdoc *mdoc, enum mdoct tok)
456 {
457 struct mdoc_node *n;
458
459 n = mdoc->last;
460 if (MDOC_ELEM != n->type)
461 n = n->parent;
462 assert(MDOC_ELEM == n->type);
463 assert(tok == n->tok);
464
465 return(rew_last(mdoc, n));
466 }
467
468 /*
469 * We are trying to close a block identified by tok,
470 * but the child block *broken is still open.
471 * Thus, postpone closing the tok block
472 * until the rew_sub call closing *broken.
473 */
474 static int
475 make_pending(struct mdoc_node *broken, enum mdoct tok,
476 struct mdoc *mdoc, int line, int ppos)
477 {
478 struct mdoc_node *breaker;
479
480 /*
481 * Iterate backwards, searching for the block matching tok,
482 * that is, the block breaking the *broken block.
483 */
484 for (breaker = broken->parent; breaker; breaker = breaker->parent) {
485
486 /*
487 * If the *broken block had already been broken before
488 * and we encounter its breaker, make the tok block
489 * pending on the inner breaker.
490 * Graphically, "[A breaker=[B broken=[C->B B] tok=A] C]"
491 * becomes "[A broken=[B [C->B B] tok=A] C]"
492 * and finally "[A [B->A [C->B B] A] C]".
493 */
494 if (breaker == broken->pending) {
495 broken = breaker;
496 continue;
497 }
498
499 if (REWIND_THIS != rew_dohalt(tok, MDOC_BLOCK, breaker))
500 continue;
501 if (MDOC_BODY == broken->type)
502 broken = broken->parent;
503
504 /*
505 * Found the breaker.
506 * If another, outer breaker is already pending on
507 * the *broken block, we must not clobber the link
508 * to the outer breaker, but make it pending on the
509 * new, now inner breaker.
510 * Graphically, "[A breaker=[B broken=[C->A A] tok=B] C]"
511 * becomes "[A breaker=[B->A broken=[C A] tok=B] C]"
512 * and finally "[A [B->A [C->B A] B] C]".
513 */
514 if (broken->pending) {
515 struct mdoc_node *taker;
516
517 /*
518 * If the breaker had also been broken before,
519 * it cannot take on the outer breaker itself,
520 * but must hand it on to its own breakers.
521 * Graphically, this is the following situation:
522 * "[A [B breaker=[C->B B] broken=[D->A A] tok=C] D]"
523 * "[A taker=[B->A breaker=[C->B B] [D->C A] C] D]"
524 */
525 taker = breaker;
526 while (taker->pending)
527 taker = taker->pending;
528 taker->pending = broken->pending;
529 }
530 broken->pending = breaker;
531 mandoc_vmsg(MANDOCERR_BLOCK_NEST, mdoc->parse, line, ppos,
532 "%s breaks %s", mdoc_macronames[tok],
533 mdoc_macronames[broken->tok]);
534 return(1);
535 }
536
537 /*
538 * Found no matching block for tok.
539 * Are you trying to close a block that is not open?
540 */
541 return(0);
542 }
543
544 static int
545 rew_sub(enum mdoc_type t, struct mdoc *mdoc,
546 enum mdoct tok, int line, int ppos)
547 {
548 struct mdoc_node *n;
549
550 n = mdoc->last;
551 while (n) {
552 switch (rew_dohalt(tok, t, n)) {
553 case REWIND_NONE:
554 return(1);
555 case REWIND_THIS:
556 n->lastline = line -
557 (MDOC_NEWLINE & mdoc->flags &&
558 ! (MDOC_EXPLICIT & mdoc_macros[tok].flags));
559 break;
560 case REWIND_FORCE:
561 mandoc_vmsg(MANDOCERR_SCOPEBROKEN, mdoc->parse,
562 line, ppos, "%s breaks %s",
563 mdoc_macronames[tok],
564 mdoc_macronames[n->tok]);
565 /* FALLTHROUGH */
566 case REWIND_MORE:
567 n->lastline = line -
568 (MDOC_NEWLINE & mdoc->flags ? 1 : 0);
569 n = n->parent;
570 continue;
571 case REWIND_LATER:
572 if (make_pending(n, tok, mdoc, line, ppos) ||
573 MDOC_BLOCK != t)
574 return(1);
575 /* FALLTHROUGH */
576 case REWIND_ERROR:
577 mdoc_pmsg(mdoc, line, ppos, MANDOCERR_NOSCOPE);
578 return(1);
579 }
580 break;
581 }
582
583 assert(n);
584 if ( ! rew_last(mdoc, n))
585 return(0);
586
587 /*
588 * The current block extends an enclosing block.
589 * Now that the current block ends, close the enclosing block, too.
590 */
591 while (NULL != (n = n->pending)) {
592 if ( ! rew_last(mdoc, n))
593 return(0);
594 if (MDOC_HEAD == n->type &&
595 ! mdoc_body_alloc(mdoc, n->line, n->pos, n->tok))
596 return(0);
597 }
598
599 return(1);
600 }
601
602 /*
603 * Allocate a word and check whether it's punctuation or not.
604 * Punctuation consists of those tokens found in mdoc_isdelim().
605 */
606 static int
607 dword(struct mdoc *mdoc, int line, int col, const char *p,
608 enum mdelim d, int may_append)
609 {
610
611 if (DELIM_MAX == d)
612 d = mdoc_isdelim(p);
613
614 if (may_append &&
615 ! ((MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF) & mdoc->flags) &&
616 DELIM_NONE == d && MDOC_TEXT == mdoc->last->type &&
617 DELIM_NONE == mdoc_isdelim(mdoc->last->string)) {
618 mdoc_word_append(mdoc, p);
619 return(1);
620 }
621
622 if ( ! mdoc_word_alloc(mdoc, line, col, p))
623 return(0);
624
625 if (DELIM_OPEN == d)
626 mdoc->last->flags |= MDOC_DELIMO;
627
628 /*
629 * Closing delimiters only suppress the preceding space
630 * when they follow something, not when they start a new
631 * block or element, and not when they follow `No'.
632 *
633 * XXX Explicitly special-casing MDOC_No here feels
634 * like a layering violation. Find a better way
635 * and solve this in the code related to `No'!
636 */
637
638 else if (DELIM_CLOSE == d && mdoc->last->prev &&
639 mdoc->last->prev->tok != MDOC_No &&
640 mdoc->last->parent->tok != MDOC_Fd)
641 mdoc->last->flags |= MDOC_DELIMC;
642
643 return(1);
644 }
645
646 static int
647 append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
648 {
649 int la;
650 enum margserr ac;
651 char *p;
652
653 if ('\0' == buf[*pos])
654 return(1);
655
656 for (;;) {
657 la = *pos;
658 ac = mdoc_zargs(mdoc, line, pos, buf, &p);
659
660 if (ARGS_ERROR == ac)
661 return(0);
662 else if (ARGS_EOLN == ac)
663 break;
664
665 dword(mdoc, line, la, p, DELIM_MAX, 1);
666
667 /*
668 * If we encounter end-of-sentence symbols, then trigger
669 * the double-space.
670 *
671 * XXX: it's easy to allow this to propagate outward to
672 * the last symbol, such that `. )' will cause the
673 * correct double-spacing. However, (1) groff isn't
674 * smart enough to do this and (2) it would require
675 * knowing which symbols break this behaviour, for
676 * example, `. ;' shouldn't propagate the double-space.
677 */
678 if (mandoc_eos(p, strlen(p)))
679 mdoc->last->flags |= MDOC_EOS;
680 }
681
682 return(1);
683 }
684
685 /*
686 * Close out block partial/full explicit.
687 */
688 static int
689 blk_exp_close(MACRO_PROT_ARGS)
690 {
691 struct mdoc_node *body; /* Our own body. */
692 struct mdoc_node *later; /* A sub-block starting later. */
693 struct mdoc_node *n; /* For searching backwards. */
694
695 int j, lastarg, maxargs, flushed, nl;
696 enum margserr ac;
697 enum mdoct atok, ntok;
698 char *p;
699
700 nl = MDOC_NEWLINE & mdoc->flags;
701
702 switch (tok) {
703 case MDOC_Ec:
704 maxargs = 1;
705 break;
706 case MDOC_Ek:
707 mdoc->flags &= ~MDOC_KEEP;
708 default:
709 maxargs = 0;
710 break;
711 }
712
713 /*
714 * Search backwards for beginnings of blocks,
715 * both of our own and of pending sub-blocks.
716 */
717 atok = rew_alt(tok);
718 body = later = NULL;
719 for (n = mdoc->last; n; n = n->parent) {
720 if (MDOC_VALID & n->flags)
721 continue;
722
723 /* Remember the start of our own body. */
724 if (MDOC_BODY == n->type && atok == n->tok) {
725 if (ENDBODY_NOT == n->end)
726 body = n;
727 continue;
728 }
729
730 if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok)
731 continue;
732 if (atok == n->tok) {
733 assert(body);
734
735 /*
736 * Found the start of our own block.
737 * When there is no pending sub block,
738 * just proceed to closing out.
739 */
740 if (NULL == later)
741 break;
742
743 /*
744 * When there is a pending sub block,
745 * postpone closing out the current block
746 * until the rew_sub() closing out the sub-block.
747 */
748 make_pending(later, tok, mdoc, line, ppos);
749
750 /*
751 * Mark the place where the formatting - but not
752 * the scope - of the current block ends.
753 */
754 if ( ! mdoc_endbody_alloc(mdoc, line, ppos,
755 atok, body, ENDBODY_SPACE))
756 return(0);
757 break;
758 }
759
760 /*
761 * When finding an open sub block, remember the last
762 * open explicit block, or, in case there are only
763 * implicit ones, the first open implicit block.
764 */
765 if (later &&
766 MDOC_EXPLICIT & mdoc_macros[later->tok].flags)
767 continue;
768 if (MDOC_It != n->tok)
769 later = n;
770 }
771
772 if ( ! (MDOC_PARSED & mdoc_macros[tok].flags)) {
773 if ('\0' != buf[*pos])
774 mandoc_vmsg(MANDOCERR_ARG_SKIP,
775 mdoc->parse, line, ppos,
776 "%s %s", mdoc_macronames[tok],
777 buf + *pos);
778 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
779 return(0);
780 return(rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos));
781 }
782
783 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
784 return(0);
785
786 if (NULL == later && maxargs > 0)
787 if ( ! mdoc_tail_alloc(mdoc, line, ppos, rew_alt(tok)))
788 return(0);
789
790 for (flushed = j = 0; ; j++) {
791 lastarg = *pos;
792
793 if (j == maxargs && ! flushed) {
794 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
795 return(0);
796 flushed = 1;
797 }
798
799 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
800
801 if (ARGS_ERROR == ac)
802 return(0);
803 if (ARGS_PUNCT == ac)
804 break;
805 if (ARGS_EOLN == ac)
806 break;
807
808 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
809
810 if (MDOC_MAX == ntok) {
811 if ( ! dword(mdoc, line, lastarg, p, DELIM_MAX,
812 MDOC_JOIN & mdoc_macros[tok].flags))
813 return(0);
814 continue;
815 }
816
817 if ( ! flushed) {
818 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
819 return(0);
820 flushed = 1;
821 }
822
823 mdoc->flags &= ~MDOC_NEWLINE;
824
825 if ( ! mdoc_macro(mdoc, ntok, line, lastarg, pos, buf))
826 return(0);
827 break;
828 }
829
830 if ( ! flushed && ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
831 return(0);
832
833 if ( ! nl)
834 return(1);
835 return(append_delims(mdoc, line, pos, buf));
836 }
837
838 static int
839 in_line(MACRO_PROT_ARGS)
840 {
841 int la, scope, cnt, nc, nl;
842 enum margverr av;
843 enum mdoct ntok;
844 enum margserr ac;
845 enum mdelim d;
846 struct mdoc_arg *arg;
847 char *p;
848
849 nl = MDOC_NEWLINE & mdoc->flags;
850
851 /*
852 * Whether we allow ignored elements (those without content,
853 * usually because of reserved words) to squeak by.
854 */
855
856 switch (tok) {
857 case MDOC_An:
858 /* FALLTHROUGH */
859 case MDOC_Ar:
860 /* FALLTHROUGH */
861 case MDOC_Fl:
862 /* FALLTHROUGH */
863 case MDOC_Mt:
864 /* FALLTHROUGH */
865 case MDOC_Nm:
866 /* FALLTHROUGH */
867 case MDOC_Pa:
868 nc = 1;
869 break;
870 default:
871 nc = 0;
872 break;
873 }
874
875 for (arg = NULL;; ) {
876 la = *pos;
877 av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
878
879 if (ARGV_WORD == av) {
880 *pos = la;
881 break;
882 }
883 if (ARGV_EOLN == av)
884 break;
885 if (ARGV_ARG == av)
886 continue;
887
888 mdoc_argv_free(arg);
889 return(0);
890 }
891
892 for (cnt = scope = 0;; ) {
893 la = *pos;
894 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
895
896 if (ARGS_ERROR == ac)
897 return(0);
898 if (ARGS_EOLN == ac)
899 break;
900 if (ARGS_PUNCT == ac)
901 break;
902
903 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
904
905 /*
906 * In this case, we've located a submacro and must
907 * execute it. Close out scope, if open. If no
908 * elements have been generated, either create one (nc)
909 * or raise a warning.
910 */
911
912 if (MDOC_MAX != ntok) {
913 if (scope && ! rew_elem(mdoc, tok))
914 return(0);
915 if (nc && 0 == cnt) {
916 if ( ! mdoc_elem_alloc(mdoc,
917 line, ppos, tok, arg))
918 return(0);
919 if ( ! rew_last(mdoc, mdoc->last))
920 return(0);
921 } else if ( ! nc && 0 == cnt) {
922 mdoc_argv_free(arg);
923 mandoc_msg(MANDOCERR_MACRO_EMPTY,
924 mdoc->parse, line, ppos,
925 mdoc_macronames[tok]);
926 }
927
928 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
929 return(0);
930 if ( ! nl)
931 return(1);
932 return(append_delims(mdoc, line, pos, buf));
933 }
934
935 /*
936 * Non-quote-enclosed punctuation. Set up our scope, if
937 * a word; rewind the scope, if a delimiter; then append
938 * the word.
939 */
940
941 d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p);
942
943 if (DELIM_NONE != d) {
944 /*
945 * If we encounter closing punctuation, no word
946 * has been omitted, no scope is open, and we're
947 * allowed to have an empty element, then start
948 * a new scope. `Ar', `Fl', and `Li', only do
949 * this once per invocation. There may be more
950 * of these (all of them?).
951 */
952 if (0 == cnt && (nc || MDOC_Li == tok) &&
953 DELIM_CLOSE == d && ! scope) {
954 if ( ! mdoc_elem_alloc(mdoc,
955 line, ppos, tok, arg))
956 return(0);
957 if (MDOC_Ar == tok || MDOC_Li == tok ||
958 MDOC_Fl == tok)
959 cnt++;
960 scope = 1;
961 }
962 /*
963 * Close out our scope, if one is open, before
964 * any punctuation.
965 */
966 if (scope && ! rew_elem(mdoc, tok))
967 return(0);
968 scope = 0;
969 } else if ( ! scope) {
970 if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
971 return(0);
972 scope = 1;
973 }
974
975 if (DELIM_NONE == d)
976 cnt++;
977
978 if ( ! dword(mdoc, line, la, p, d,
979 MDOC_JOIN & mdoc_macros[tok].flags))
980 return(0);
981
982 /*
983 * `Fl' macros have their scope re-opened with each new
984 * word so that the `-' can be added to each one without
985 * having to parse out spaces.
986 */
987 if (scope && MDOC_Fl == tok) {
988 if ( ! rew_elem(mdoc, tok))
989 return(0);
990 scope = 0;
991 }
992 }
993
994 if (scope && ! rew_elem(mdoc, tok))
995 return(0);
996
997 /*
998 * If no elements have been collected and we're allowed to have
999 * empties (nc), open a scope and close it out. Otherwise,
1000 * raise a warning.
1001 */
1002
1003 if (nc && 0 == cnt) {
1004 if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1005 return(0);
1006 if ( ! rew_last(mdoc, mdoc->last))
1007 return(0);
1008 } else if ( ! nc && 0 == cnt) {
1009 mdoc_argv_free(arg);
1010 mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
1011 line, ppos, mdoc_macronames[tok]);
1012 }
1013
1014 if ( ! nl)
1015 return(1);
1016 return(append_delims(mdoc, line, pos, buf));
1017 }
1018
1019 static int
1020 blk_full(MACRO_PROT_ARGS)
1021 {
1022 int la, nl, nparsed;
1023 struct mdoc_arg *arg;
1024 struct mdoc_node *head; /* save of head macro */
1025 struct mdoc_node *body; /* save of body macro */
1026 struct mdoc_node *n;
1027 enum mdoc_type mtt;
1028 enum mdoct ntok;
1029 enum margserr ac, lac;
1030 enum margverr av;
1031 char *p;
1032
1033 nl = MDOC_NEWLINE & mdoc->flags;
1034
1035 /* Close out prior implicit scope. */
1036
1037 if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
1038 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1039 return(0);
1040 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1041 return(0);
1042 }
1043
1044 /*
1045 * This routine accommodates implicitly- and explicitly-scoped
1046 * macro openings. Implicit ones first close out prior scope
1047 * (seen above). Delay opening the head until necessary to
1048 * allow leading punctuation to print. Special consideration
1049 * for `It -column', which has phrase-part syntax instead of
1050 * regular child nodes.
1051 */
1052
1053 for (arg = NULL;; ) {
1054 la = *pos;
1055 av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1056
1057 if (ARGV_WORD == av) {
1058 *pos = la;
1059 break;
1060 }
1061
1062 if (ARGV_EOLN == av)
1063 break;
1064 if (ARGV_ARG == av)
1065 continue;
1066
1067 mdoc_argv_free(arg);
1068 return(0);
1069 }
1070
1071 if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg))
1072 return(0);
1073
1074 head = body = NULL;
1075
1076 /*
1077 * Exception: Heads of `It' macros in `-diag' lists are not
1078 * parsed, even though `It' macros in general are parsed.
1079 */
1080 nparsed = MDOC_It == tok &&
1081 MDOC_Bl == mdoc->last->parent->tok &&
1082 LIST_diag == mdoc->last->parent->norm->Bl.type;
1083
1084 /*
1085 * The `Nd' macro has all arguments in its body: it's a hybrid
1086 * of block partial-explicit and full-implicit. Stupid.
1087 */
1088
1089 if (MDOC_Nd == tok) {
1090 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1091 return(0);
1092 head = mdoc->last;
1093 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1094 return(0);
1095 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1096 return(0);
1097 body = mdoc->last;
1098 }
1099
1100 if (MDOC_Bk == tok)
1101 mdoc->flags |= MDOC_KEEP;
1102
1103 ac = ARGS_ERROR;
1104
1105 for ( ; ; ) {
1106 la = *pos;
1107 /* Initialise last-phrase-type with ARGS_PEND. */
1108 lac = ARGS_ERROR == ac ? ARGS_PEND : ac;
1109 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1110
1111 if (ARGS_PUNCT == ac)
1112 break;
1113
1114 if (ARGS_ERROR == ac)
1115 return(0);
1116
1117 if (ARGS_EOLN == ac) {
1118 if (ARGS_PPHRASE != lac && ARGS_PHRASE != lac)
1119 break;
1120 /*
1121 * This is necessary: if the last token on a
1122 * line is a `Ta' or tab, then we'll get
1123 * ARGS_EOLN, so we must be smart enough to
1124 * reopen our scope if the last parse was a
1125 * phrase or partial phrase.
1126 */
1127 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1128 return(0);
1129 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1130 return(0);
1131 body = mdoc->last;
1132 break;
1133 }
1134
1135 /*
1136 * Emit leading punctuation (i.e., punctuation before
1137 * the MDOC_HEAD) for non-phrase types.
1138 */
1139
1140 if (NULL == head &&
1141 ARGS_PEND != ac &&
1142 ARGS_PHRASE != ac &&
1143 ARGS_PPHRASE != ac &&
1144 ARGS_QWORD != ac &&
1145 DELIM_OPEN == mdoc_isdelim(p)) {
1146 if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1147 return(0);
1148 continue;
1149 }
1150
1151 /* Open a head if one hasn't been opened. */
1152
1153 if (NULL == head) {
1154 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1155 return(0);
1156 head = mdoc->last;
1157 }
1158
1159 if (ARGS_PHRASE == ac ||
1160 ARGS_PEND == ac ||
1161 ARGS_PPHRASE == ac) {
1162 /*
1163 * If we haven't opened a body yet, rewind the
1164 * head; if we have, rewind that instead.
1165 */
1166
1167 mtt = body ? MDOC_BODY : MDOC_HEAD;
1168 if ( ! rew_sub(mtt, mdoc, tok, line, ppos))
1169 return(0);
1170
1171 /* Then allocate our body context. */
1172
1173 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1174 return(0);
1175 body = mdoc->last;
1176
1177 /*
1178 * Process phrases: set whether we're in a
1179 * partial-phrase (this effects line handling)
1180 * then call down into the phrase parser.
1181 */
1182
1183 if (ARGS_PPHRASE == ac)
1184 mdoc->flags |= MDOC_PPHRASE;
1185 if (ARGS_PEND == ac && ARGS_PPHRASE == lac)
1186 mdoc->flags |= MDOC_PPHRASE;
1187
1188 if ( ! phrase(mdoc, line, la, buf))
1189 return(0);
1190
1191 mdoc->flags &= ~MDOC_PPHRASE;
1192 continue;
1193 }
1194
1195 ntok = nparsed || ARGS_QWORD == ac ?
1196 MDOC_MAX : lookup(tok, p);
1197
1198 if (MDOC_MAX == ntok) {
1199 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1200 MDOC_JOIN & mdoc_macros[tok].flags))
1201 return(0);
1202 continue;
1203 }
1204
1205 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1206 return(0);
1207 break;
1208 }
1209
1210 if (NULL == head) {
1211 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1212 return(0);
1213 head = mdoc->last;
1214 }
1215
1216 if (nl && ! append_delims(mdoc, line, pos, buf))
1217 return(0);
1218
1219 /* If we've already opened our body, exit now. */
1220
1221 if (NULL != body)
1222 goto out;
1223
1224 /*
1225 * If there is an open (i.e., unvalidated) sub-block requiring
1226 * explicit close-out, postpone switching the current block from
1227 * head to body until the rew_sub() call closing out that
1228 * sub-block.
1229 */
1230 for (n = mdoc->last; n && n != head; n = n->parent) {
1231 if (MDOC_BLOCK == n->type &&
1232 MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1233 ! (MDOC_VALID & n->flags)) {
1234 n->pending = head;
1235 return(1);
1236 }
1237 }
1238
1239 /* Close out scopes to remain in a consistent state. */
1240
1241 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1242 return(0);
1243 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1244 return(0);
1245
1246 out:
1247 if ( ! (MDOC_FREECOL & mdoc->flags))
1248 return(1);
1249
1250 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1251 return(0);
1252 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1253 return(0);
1254
1255 mdoc->flags &= ~MDOC_FREECOL;
1256 return(1);
1257 }
1258
1259 static int
1260 blk_part_imp(MACRO_PROT_ARGS)
1261 {
1262 int la, nl;
1263 enum mdoct ntok;
1264 enum margserr ac;
1265 char *p;
1266 struct mdoc_node *blk; /* saved block context */
1267 struct mdoc_node *body; /* saved body context */
1268 struct mdoc_node *n;
1269
1270 nl = MDOC_NEWLINE & mdoc->flags;
1271
1272 /*
1273 * A macro that spans to the end of the line. This is generally
1274 * (but not necessarily) called as the first macro. The block
1275 * has a head as the immediate child, which is always empty,
1276 * followed by zero or more opening punctuation nodes, then the
1277 * body (which may be empty, depending on the macro), then zero
1278 * or more closing punctuation nodes.
1279 */
1280
1281 if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
1282 return(0);
1283
1284 blk = mdoc->last;
1285
1286 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1287 return(0);
1288 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1289 return(0);
1290
1291 /*
1292 * Open the body scope "on-demand", that is, after we've
1293 * processed all our the leading delimiters (open parenthesis,
1294 * etc.).
1295 */
1296
1297 for (body = NULL; ; ) {
1298 la = *pos;
1299 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1300
1301 if (ARGS_ERROR == ac)
1302 return(0);
1303 if (ARGS_EOLN == ac)
1304 break;
1305 if (ARGS_PUNCT == ac)
1306 break;
1307
1308 if (NULL == body && ARGS_QWORD != ac &&
1309 DELIM_OPEN == mdoc_isdelim(p)) {
1310 if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1311 return(0);
1312 continue;
1313 }
1314
1315 if (NULL == body) {
1316 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1317 return(0);
1318 body = mdoc->last;
1319 }
1320
1321 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1322
1323 if (MDOC_MAX == ntok) {
1324 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1325 MDOC_JOIN & mdoc_macros[tok].flags))
1326 return(0);
1327 continue;
1328 }
1329
1330 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1331 return(0);
1332 break;
1333 }
1334
1335 /* Clean-ups to leave in a consistent state. */
1336
1337 if (NULL == body) {
1338 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1339 return(0);
1340 body = mdoc->last;
1341 }
1342
1343 /*
1344 * If there is an open sub-block requiring explicit close-out,
1345 * postpone closing out the current block
1346 * until the rew_sub() call closing out the sub-block.
1347 */
1348 for (n = mdoc->last; n && n != body && n != blk->parent;
1349 n = n->parent) {
1350 if (MDOC_BLOCK == n->type &&
1351 MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1352 ! (MDOC_VALID & n->flags)) {
1353 make_pending(n, tok, mdoc, line, ppos);
1354 if ( ! mdoc_endbody_alloc(mdoc, line, ppos,
1355 tok, body, ENDBODY_NOSPACE))
1356 return(0);
1357 return(1);
1358 }
1359 }
1360 assert(n == body);
1361
1362 if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1363 return(0);
1364
1365 /* Standard appending of delimiters. */
1366
1367 if (nl && ! append_delims(mdoc, line, pos, buf))
1368 return(0);
1369
1370 /* Rewind scope, if applicable. */
1371
1372 if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1373 return(0);
1374
1375 /* Move trailing .Ns out of scope. */
1376
1377 for (n = body->child; n && n->next; n = n->next)
1378 /* Do nothing. */ ;
1379 if (n && MDOC_Ns == n->tok)
1380 mdoc_node_relink(mdoc, n);
1381
1382 return(1);
1383 }
1384
1385 static int
1386 blk_part_exp(MACRO_PROT_ARGS)
1387 {
1388 int la, nl;
1389 enum margserr ac;
1390 struct mdoc_node *head; /* keep track of head */
1391 struct mdoc_node *body; /* keep track of body */
1392 char *p;
1393 enum mdoct ntok;
1394
1395 nl = MDOC_NEWLINE & mdoc->flags;
1396
1397 /*
1398 * The opening of an explicit macro having zero or more leading
1399 * punctuation nodes; a head with optional single element (the
1400 * case of `Eo'); and a body that may be empty.
1401 */
1402
1403 if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
1404 return(0);
1405
1406 for (head = body = NULL; ; ) {
1407 la = *pos;
1408 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1409
1410 if (ARGS_ERROR == ac)
1411 return(0);
1412 if (ARGS_PUNCT == ac)
1413 break;
1414 if (ARGS_EOLN == ac)
1415 break;
1416
1417 /* Flush out leading punctuation. */
1418
1419 if (NULL == head && ARGS_QWORD != ac &&
1420 DELIM_OPEN == mdoc_isdelim(p)) {
1421 assert(NULL == body);
1422 if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1423 return(0);
1424 continue;
1425 }
1426
1427 if (NULL == head) {
1428 assert(NULL == body);
1429 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1430 return(0);
1431 head = mdoc->last;
1432 }
1433
1434 /*
1435 * `Eo' gobbles any data into the head, but most other
1436 * macros just immediately close out and begin the body.
1437 */
1438
1439 if (NULL == body) {
1440 assert(head);
1441 /* No check whether it's a macro! */
1442 if (MDOC_Eo == tok)
1443 if ( ! dword(mdoc, line, la, p, DELIM_MAX, 0))
1444 return(0);
1445
1446 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1447 return(0);
1448 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1449 return(0);
1450 body = mdoc->last;
1451
1452 if (MDOC_Eo == tok)
1453 continue;
1454 }
1455
1456 assert(NULL != head && NULL != body);
1457
1458 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1459
1460 if (MDOC_MAX == ntok) {
1461 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1462 MDOC_JOIN & mdoc_macros[tok].flags))
1463 return(0);
1464 continue;
1465 }
1466
1467 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1468 return(0);
1469 break;
1470 }
1471
1472 /* Clean-up to leave in a consistent state. */
1473
1474 if (NULL == head)
1475 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1476 return(0);
1477
1478 if (NULL == body) {
1479 if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1480 return(0);
1481 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1482 return(0);
1483 }
1484
1485 /* Standard appending of delimiters. */
1486
1487 if ( ! nl)
1488 return(1);
1489 return(append_delims(mdoc, line, pos, buf));
1490 }
1491
1492 static int
1493 in_line_argn(MACRO_PROT_ARGS)
1494 {
1495 int la, flushed, j, maxargs, nl;
1496 enum margserr ac;
1497 enum margverr av;
1498 struct mdoc_arg *arg;
1499 char *p;
1500 enum mdoct ntok;
1501
1502 nl = MDOC_NEWLINE & mdoc->flags;
1503
1504 /*
1505 * A line macro that has a fixed number of arguments (maxargs).
1506 * Only open the scope once the first non-leading-punctuation is
1507 * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1508 * keep it open until the maximum number of arguments are
1509 * exhausted.
1510 */
1511
1512 switch (tok) {
1513 case MDOC_Ap:
1514 /* FALLTHROUGH */
1515 case MDOC_No:
1516 /* FALLTHROUGH */
1517 case MDOC_Ns:
1518 /* FALLTHROUGH */
1519 case MDOC_Ux:
1520 maxargs = 0;
1521 break;
1522 case MDOC_Bx:
1523 /* FALLTHROUGH */
1524 case MDOC_Es:
1525 /* FALLTHROUGH */
1526 case MDOC_Xr:
1527 maxargs = 2;
1528 break;
1529 default:
1530 maxargs = 1;
1531 break;
1532 }
1533
1534 for (arg = NULL; ; ) {
1535 la = *pos;
1536 av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1537
1538 if (ARGV_WORD == av) {
1539 *pos = la;
1540 break;
1541 }
1542
1543 if (ARGV_EOLN == av)
1544 break;
1545 if (ARGV_ARG == av)
1546 continue;
1547
1548 mdoc_argv_free(arg);
1549 return(0);
1550 }
1551
1552 for (flushed = j = 0; ; ) {
1553 la = *pos;
1554 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1555
1556 if (ARGS_ERROR == ac)
1557 return(0);
1558 if (ARGS_PUNCT == ac)
1559 break;
1560 if (ARGS_EOLN == ac)
1561 break;
1562
1563 if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1564 ARGS_QWORD != ac && 0 == j &&
1565 DELIM_OPEN == mdoc_isdelim(p)) {
1566 if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1567 return(0);
1568 continue;
1569 } else if (0 == j)
1570 if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1571 return(0);
1572
1573 if (j == maxargs && ! flushed) {
1574 if ( ! rew_elem(mdoc, tok))
1575 return(0);
1576 flushed = 1;
1577 }
1578
1579 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1580
1581 if (MDOC_MAX != ntok) {
1582 if ( ! flushed && ! rew_elem(mdoc, tok))
1583 return(0);
1584 flushed = 1;
1585 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1586 return(0);
1587 j++;
1588 break;
1589 }
1590
1591 if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1592 ARGS_QWORD != ac &&
1593 ! flushed &&
1594 DELIM_NONE != mdoc_isdelim(p)) {
1595 if ( ! rew_elem(mdoc, tok))
1596 return(0);
1597 flushed = 1;
1598 }
1599
1600 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1601 MDOC_JOIN & mdoc_macros[tok].flags))
1602 return(0);
1603 j++;
1604 }
1605
1606 if (0 == j && ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1607 return(0);
1608
1609 /* Close out in a consistent state. */
1610
1611 if ( ! flushed && ! rew_elem(mdoc, tok))
1612 return(0);
1613 if ( ! nl)
1614 return(1);
1615 return(append_delims(mdoc, line, pos, buf));
1616 }
1617
1618 static int
1619 in_line_eoln(MACRO_PROT_ARGS)
1620 {
1621 int la;
1622 enum margserr ac;
1623 enum margverr av;
1624 struct mdoc_arg *arg;
1625 char *p;
1626 enum mdoct ntok;
1627
1628 assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
1629
1630 if (tok == MDOC_Pp)
1631 rew_sub(MDOC_BLOCK, mdoc, MDOC_Nm, line, ppos);
1632
1633 /* Parse macro arguments. */
1634
1635 for (arg = NULL; ; ) {
1636 la = *pos;
1637 av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1638
1639 if (ARGV_WORD == av) {
1640 *pos = la;
1641 break;
1642 }
1643 if (ARGV_EOLN == av)
1644 break;
1645 if (ARGV_ARG == av)
1646 continue;
1647
1648 mdoc_argv_free(arg);
1649 return(0);
1650 }
1651
1652 /* Open element scope. */
1653
1654 if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1655 return(0);
1656
1657 /* Parse argument terms. */
1658
1659 for (;;) {
1660 la = *pos;
1661 ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1662
1663 if (ARGS_ERROR == ac)
1664 return(0);
1665 if (ARGS_EOLN == ac)
1666 break;
1667
1668 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1669
1670 if (MDOC_MAX == ntok) {
1671 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1672 MDOC_JOIN & mdoc_macros[tok].flags))
1673 return(0);
1674 continue;
1675 }
1676
1677 if ( ! rew_elem(mdoc, tok))
1678 return(0);
1679 return(mdoc_macro(mdoc, ntok, line, la, pos, buf));
1680 }
1681
1682 /* Close out (no delimiters). */
1683
1684 return(rew_elem(mdoc, tok));
1685 }
1686
1687 static int
1688 ctx_synopsis(MACRO_PROT_ARGS)
1689 {
1690 int nl;
1691
1692 nl = MDOC_NEWLINE & mdoc->flags;
1693
1694 /* If we're not in the SYNOPSIS, go straight to in-line. */
1695 if ( ! (MDOC_SYNOPSIS & mdoc->flags))
1696 return(in_line(mdoc, tok, line, ppos, pos, buf));
1697
1698 /* If we're a nested call, same place. */
1699 if ( ! nl)
1700 return(in_line(mdoc, tok, line, ppos, pos, buf));
1701
1702 /*
1703 * XXX: this will open a block scope; however, if later we end
1704 * up formatting the block scope, then child nodes will inherit
1705 * the formatting. Be careful.
1706 */
1707 if (MDOC_Nm == tok)
1708 return(blk_full(mdoc, tok, line, ppos, pos, buf));
1709 assert(MDOC_Vt == tok);
1710 return(blk_part_imp(mdoc, tok, line, ppos, pos, buf));
1711 }
1712
1713 /*
1714 * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1715 * They're unusual because they're basically free-form text until a
1716 * macro is encountered.
1717 */
1718 static int
1719 phrase(struct mdoc *mdoc, int line, int ppos, char *buf)
1720 {
1721 int la, pos;
1722 enum margserr ac;
1723 enum mdoct ntok;
1724 char *p;
1725
1726 for (pos = ppos; ; ) {
1727 la = pos;
1728
1729 ac = mdoc_zargs(mdoc, line, &pos, buf, &p);
1730
1731 if (ARGS_ERROR == ac)
1732 return(0);
1733 if (ARGS_EOLN == ac)
1734 break;
1735
1736 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
1737
1738 if (MDOC_MAX == ntok) {
1739 if ( ! dword(mdoc, line, la, p, DELIM_MAX, 1))
1740 return(0);
1741 continue;
1742 }
1743
1744 if ( ! mdoc_macro(mdoc, ntok, line, la, &pos, buf))
1745 return(0);
1746 return(append_delims(mdoc, line, &pos, buf));
1747 }
1748
1749 return(1);
1750 }
1751
1752 static int
1753 phrase_ta(MACRO_PROT_ARGS)
1754 {
1755 struct mdoc_node *n;
1756 int la;
1757 enum mdoct ntok;
1758 enum margserr ac;
1759 char *p;
1760
1761 /* Make sure we are in a column list or ignore this macro. */
1762 n = mdoc->last;
1763 while (NULL != n && MDOC_Bl != n->tok)
1764 n = n->parent;
1765 if (NULL == n || LIST_column != n->norm->Bl.type) {
1766 mdoc_pmsg(mdoc, line, ppos, MANDOCERR_STRAYTA);
1767 return(1);
1768 }
1769
1770 /* Advance to the next column. */
1771 if ( ! rew_sub(MDOC_BODY, mdoc, MDOC_It, line, ppos))
1772 return(0);
1773 if ( ! mdoc_body_alloc(mdoc, line, ppos, MDOC_It))
1774 return(0);
1775
1776 for (;;) {
1777 la = *pos;
1778 ac = mdoc_zargs(mdoc, line, pos, buf, &p);
1779
1780 if (ARGS_ERROR == ac)
1781 return(0);
1782 if (ARGS_EOLN == ac)
1783 break;
1784
1785 ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
1786
1787 if (MDOC_MAX == ntok) {
1788 if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1789 MDOC_JOIN & mdoc_macros[tok].flags))
1790 return(0);
1791 continue;
1792 }
1793
1794 if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1795 return(0);
1796 return(append_delims(mdoc, line, pos, buf));
1797 }
1798
1799 return(1);
1800 }
A git conversion mirror of mandoc.bsd.lv