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