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