Annotation of src/usr.bin/mandoc/mdoc_macro.c, Revision 1.81
1.81 ! schwarze 1: /* $Id: mdoc_macro.c,v 1.80 2013/10/21 23:32:32 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):
1.81 ! schwarze 560: n->lastline = line -
! 561: (MDOC_NEWLINE & mdoc->flags &&
! 562: ! (MDOC_EXPLICIT & mdoc_macros[tok].flags));
1.48 schwarze 563: break;
1.59 schwarze 564: case (REWIND_FORCE):
1.76 schwarze 565: mandoc_vmsg(MANDOCERR_SCOPEBROKEN, mdoc->parse,
1.66 schwarze 566: line, ppos, "%s breaks %s",
567: mdoc_macronames[tok],
568: mdoc_macronames[n->tok]);
1.59 schwarze 569: /* FALLTHROUGH */
1.48 schwarze 570: case (REWIND_MORE):
1.81 ! schwarze 571: n->lastline = line -
! 572: (MDOC_NEWLINE & mdoc->flags ? 1 : 0);
1.48 schwarze 573: n = n->parent;
574: continue;
575: case (REWIND_LATER):
1.76 schwarze 576: if (make_pending(n, tok, mdoc, line, ppos) ||
1.59 schwarze 577: MDOC_BLOCK != t)
578: return(1);
579: /* FALLTHROUGH */
1.48 schwarze 580: case (REWIND_ERROR):
1.76 schwarze 581: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_NOSCOPE);
1.59 schwarze 582: return(1);
1.22 schwarze 583: }
1.48 schwarze 584: break;
1.1 kristaps 585: }
586:
587: assert(n);
1.76 schwarze 588: if ( ! rew_last(mdoc, n))
1.29 schwarze 589: return(0);
590:
591: /*
1.47 schwarze 592: * The current block extends an enclosing block.
593: * Now that the current block ends, close the enclosing block, too.
1.29 schwarze 594: */
1.47 schwarze 595: while (NULL != (n = n->pending)) {
1.76 schwarze 596: if ( ! rew_last(mdoc, n))
1.29 schwarze 597: return(0);
1.47 schwarze 598: if (MDOC_HEAD == n->type &&
1.76 schwarze 599: ! mdoc_body_alloc(mdoc, n->line, n->pos, n->tok))
1.29 schwarze 600: return(0);
601: }
1.54 schwarze 602:
1.29 schwarze 603: return(1);
1.1 kristaps 604: }
605:
1.66 schwarze 606: /*
607: * Allocate a word and check whether it's punctuation or not.
608: * Punctuation consists of those tokens found in mdoc_isdelim().
609: */
610: static int
1.80 schwarze 611: dword(struct mdoc *mdoc, int line, int col, const char *p,
612: enum mdelim d, int may_append)
1.66 schwarze 613: {
614:
615: if (DELIM_MAX == d)
616: d = mdoc_isdelim(p);
617:
1.80 schwarze 618: if (may_append &&
619: ! ((MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF) & mdoc->flags) &&
620: DELIM_NONE == d && MDOC_TEXT == mdoc->last->type &&
621: DELIM_NONE == mdoc_isdelim(mdoc->last->string)) {
622: mdoc_word_append(mdoc, p);
623: return(1);
624: }
625:
1.76 schwarze 626: if ( ! mdoc_word_alloc(mdoc, line, col, p))
1.66 schwarze 627: return(0);
628:
629: if (DELIM_OPEN == d)
1.76 schwarze 630: mdoc->last->flags |= MDOC_DELIMO;
1.71 schwarze 631:
632: /*
633: * Closing delimiters only suppress the preceding space
634: * when they follow something, not when they start a new
635: * block or element, and not when they follow `No'.
636: *
637: * XXX Explicitly special-casing MDOC_No here feels
638: * like a layering violation. Find a better way
639: * and solve this in the code related to `No'!
640: */
641:
1.76 schwarze 642: else if (DELIM_CLOSE == d && mdoc->last->prev &&
1.77 schwarze 643: mdoc->last->prev->tok != MDOC_No &&
644: mdoc->last->parent->tok != MDOC_Fd)
1.76 schwarze 645: mdoc->last->flags |= MDOC_DELIMC;
1.66 schwarze 646:
647: return(1);
648: }
1.1 kristaps 649:
650: static int
1.76 schwarze 651: append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
1.1 kristaps 652: {
1.42 schwarze 653: int la;
1.36 schwarze 654: enum margserr ac;
1.1 kristaps 655: char *p;
656:
1.42 schwarze 657: if ('\0' == buf[*pos])
1.1 kristaps 658: return(1);
659:
660: for (;;) {
1.42 schwarze 661: la = *pos;
1.76 schwarze 662: ac = mdoc_zargs(mdoc, line, pos, buf, &p);
1.1 kristaps 663:
1.36 schwarze 664: if (ARGS_ERROR == ac)
1.1 kristaps 665: return(0);
1.36 schwarze 666: else if (ARGS_EOLN == ac)
1.1 kristaps 667: break;
1.42 schwarze 668:
1.80 schwarze 669: dword(mdoc, line, la, p, DELIM_MAX, 1);
1.43 schwarze 670:
1.42 schwarze 671: /*
672: * If we encounter end-of-sentence symbols, then trigger
673: * the double-space.
674: *
1.68 schwarze 675: * XXX: it's easy to allow this to propagate outward to
1.42 schwarze 676: * the last symbol, such that `. )' will cause the
677: * correct double-spacing. However, (1) groff isn't
678: * smart enough to do this and (2) it would require
679: * knowing which symbols break this behaviour, for
1.68 schwarze 680: * example, `. ;' shouldn't propagate the double-space.
1.42 schwarze 681: */
1.55 schwarze 682: if (mandoc_eos(p, strlen(p), 0))
1.76 schwarze 683: mdoc->last->flags |= MDOC_EOS;
1.1 kristaps 684: }
685:
686: return(1);
687: }
688:
689:
690: /*
691: * Close out block partial/full explicit.
692: */
693: static int
694: blk_exp_close(MACRO_PROT_ARGS)
695: {
1.47 schwarze 696: struct mdoc_node *body; /* Our own body. */
697: struct mdoc_node *later; /* A sub-block starting later. */
698: struct mdoc_node *n; /* For searching backwards. */
699:
1.37 schwarze 700: int j, lastarg, maxargs, flushed, nl;
1.36 schwarze 701: enum margserr ac;
1.47 schwarze 702: enum mdoct atok, ntok;
1.1 kristaps 703: char *p;
704:
1.76 schwarze 705: nl = MDOC_NEWLINE & mdoc->flags;
1.37 schwarze 706:
1.1 kristaps 707: switch (tok) {
708: case (MDOC_Ec):
709: maxargs = 1;
710: break;
1.80 schwarze 711: case (MDOC_Ek):
712: if ( ! (MDOC_SYNOPSIS & mdoc->flags))
713: mdoc->flags &= ~MDOC_KEEP;
1.1 kristaps 714: default:
715: maxargs = 0;
716: break;
717: }
718:
1.47 schwarze 719: /*
720: * Search backwards for beginnings of blocks,
721: * both of our own and of pending sub-blocks.
722: */
723: atok = rew_alt(tok);
724: body = later = NULL;
1.76 schwarze 725: for (n = mdoc->last; n; n = n->parent) {
1.47 schwarze 726: if (MDOC_VALID & n->flags)
727: continue;
728:
729: /* Remember the start of our own body. */
730: if (MDOC_BODY == n->type && atok == n->tok) {
1.54 schwarze 731: if (ENDBODY_NOT == n->end)
1.47 schwarze 732: body = n;
733: continue;
734: }
735:
1.51 schwarze 736: if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok)
1.47 schwarze 737: continue;
738: if (atok == n->tok) {
739: assert(body);
740:
741: /*
742: * Found the start of our own block.
743: * When there is no pending sub block,
744: * just proceed to closing out.
745: */
746: if (NULL == later)
747: break;
748:
749: /*
750: * When there is a pending sub block,
751: * postpone closing out the current block
752: * until the rew_sub() closing out the sub-block.
753: */
1.76 schwarze 754: make_pending(later, tok, mdoc, line, ppos);
1.47 schwarze 755:
756: /*
757: * Mark the place where the formatting - but not
758: * the scope - of the current block ends.
759: */
1.76 schwarze 760: if ( ! mdoc_endbody_alloc(mdoc, line, ppos,
1.47 schwarze 761: atok, body, ENDBODY_SPACE))
762: return(0);
763: break;
764: }
765:
766: /*
767: * When finding an open sub block, remember the last
768: * open explicit block, or, in case there are only
769: * implicit ones, the first open implicit block.
770: */
771: if (later &&
772: MDOC_EXPLICIT & mdoc_macros[later->tok].flags)
773: continue;
1.75 schwarze 774: if (MDOC_It != n->tok)
1.47 schwarze 775: later = n;
776: }
777:
1.1 kristaps 778: if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
1.44 schwarze 779: /* FIXME: do this in validate */
1.14 schwarze 780: if (buf[*pos])
1.76 schwarze 781: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_ARGSLOST);
1.14 schwarze 782:
1.76 schwarze 783: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.14 schwarze 784: return(0);
1.76 schwarze 785: return(rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos));
1.1 kristaps 786: }
787:
1.76 schwarze 788: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.1 kristaps 789: return(0);
790:
1.47 schwarze 791: if (NULL == later && maxargs > 0)
1.76 schwarze 792: if ( ! mdoc_tail_alloc(mdoc, line, ppos, rew_alt(tok)))
1.1 kristaps 793: return(0);
794:
1.20 schwarze 795: for (flushed = j = 0; ; j++) {
1.1 kristaps 796: lastarg = *pos;
797:
798: if (j == maxargs && ! flushed) {
1.76 schwarze 799: if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.1 kristaps 800: return(0);
801: flushed = 1;
802: }
803:
1.76 schwarze 804: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 805:
1.36 schwarze 806: if (ARGS_ERROR == ac)
1.1 kristaps 807: return(0);
1.36 schwarze 808: if (ARGS_PUNCT == ac)
1.1 kristaps 809: break;
1.36 schwarze 810: if (ARGS_EOLN == ac)
1.1 kristaps 811: break;
812:
1.36 schwarze 813: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
814:
815: if (MDOC_MAX == ntok) {
1.80 schwarze 816: if ( ! dword(mdoc, line, lastarg, p, DELIM_MAX,
817: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 818: return(0);
1.36 schwarze 819: continue;
820: }
1.1 kristaps 821:
1.36 schwarze 822: if ( ! flushed) {
1.76 schwarze 823: if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.36 schwarze 824: return(0);
825: flushed = 1;
826: }
1.79 schwarze 827:
828: mdoc->flags &= ~MDOC_NEWLINE;
829:
1.76 schwarze 830: if ( ! mdoc_macro(mdoc, ntok, line, lastarg, pos, buf))
1.1 kristaps 831: return(0);
1.36 schwarze 832: break;
1.1 kristaps 833: }
834:
1.76 schwarze 835: if ( ! flushed && ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.1 kristaps 836: return(0);
837:
1.37 schwarze 838: if ( ! nl)
1.1 kristaps 839: return(1);
1.76 schwarze 840: return(append_delims(mdoc, line, pos, buf));
1.1 kristaps 841: }
842:
843:
844: static int
845: in_line(MACRO_PROT_ARGS)
846: {
1.45 schwarze 847: int la, scope, cnt, nc, nl;
1.36 schwarze 848: enum margverr av;
849: enum mdoct ntok;
850: enum margserr ac;
1.40 schwarze 851: enum mdelim d;
1.36 schwarze 852: struct mdoc_arg *arg;
853: char *p;
1.1 kristaps 854:
1.76 schwarze 855: nl = MDOC_NEWLINE & mdoc->flags;
1.37 schwarze 856:
1.1 kristaps 857: /*
858: * Whether we allow ignored elements (those without content,
859: * usually because of reserved words) to squeak by.
860: */
1.32 schwarze 861:
1.1 kristaps 862: switch (tok) {
1.19 schwarze 863: case (MDOC_An):
864: /* FALLTHROUGH */
865: case (MDOC_Ar):
1.1 kristaps 866: /* FALLTHROUGH */
867: case (MDOC_Fl):
868: /* FALLTHROUGH */
1.60 schwarze 869: case (MDOC_Mt):
1.18 schwarze 870: /* FALLTHROUGH */
1.19 schwarze 871: case (MDOC_Nm):
872: /* FALLTHROUGH */
1.18 schwarze 873: case (MDOC_Pa):
1.1 kristaps 874: nc = 1;
875: break;
876: default:
877: nc = 0;
878: break;
879: }
880:
1.20 schwarze 881: for (arg = NULL;; ) {
1.1 kristaps 882: la = *pos;
1.76 schwarze 883: av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1 kristaps 884:
1.36 schwarze 885: if (ARGV_WORD == av) {
1.1 kristaps 886: *pos = la;
887: break;
888: }
1.36 schwarze 889: if (ARGV_EOLN == av)
1.1 kristaps 890: break;
1.36 schwarze 891: if (ARGV_ARG == av)
1.1 kristaps 892: continue;
893:
894: mdoc_argv_free(arg);
895: return(0);
896: }
897:
1.45 schwarze 898: for (cnt = scope = 0;; ) {
1.1 kristaps 899: la = *pos;
1.76 schwarze 900: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 901:
1.36 schwarze 902: if (ARGS_ERROR == ac)
1.1 kristaps 903: return(0);
1.36 schwarze 904: if (ARGS_EOLN == ac)
1.1 kristaps 905: break;
1.36 schwarze 906: if (ARGS_PUNCT == ac)
1.1 kristaps 907: break;
908:
1.36 schwarze 909: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1.1 kristaps 910:
911: /*
912: * In this case, we've located a submacro and must
913: * execute it. Close out scope, if open. If no
914: * elements have been generated, either create one (nc)
915: * or raise a warning.
916: */
917:
1.36 schwarze 918: if (MDOC_MAX != ntok) {
1.76 schwarze 919: if (scope && ! rew_elem(mdoc, tok))
1.1 kristaps 920: return(0);
921: if (nc && 0 == cnt) {
1.76 schwarze 922: if ( ! mdoc_elem_alloc(mdoc, line,
923: ppos, tok, arg))
1.1 kristaps 924: return(0);
1.76 schwarze 925: if ( ! rew_last(mdoc, mdoc->last))
1.3 schwarze 926: return(0);
1.1 kristaps 927: } else if ( ! nc && 0 == cnt) {
928: mdoc_argv_free(arg);
1.76 schwarze 929: mdoc_pmsg(mdoc, line, ppos,
930: MANDOCERR_MACROEMPTY);
1.1 kristaps 931: }
1.65 schwarze 932:
1.76 schwarze 933: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.1 kristaps 934: return(0);
1.37 schwarze 935: if ( ! nl)
1.1 kristaps 936: return(1);
1.76 schwarze 937: return(append_delims(mdoc, line, pos, buf));
1.21 schwarze 938: }
1.1 kristaps 939:
940: /*
941: * Non-quote-enclosed punctuation. Set up our scope, if
942: * a word; rewind the scope, if a delimiter; then append
943: * the word.
944: */
945:
1.66 schwarze 946: d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p);
1.1 kristaps 947:
1.45 schwarze 948: if (DELIM_NONE != d) {
949: /*
950: * If we encounter closing punctuation, no word
951: * has been omitted, no scope is open, and we're
952: * allowed to have an empty element, then start
953: * a new scope. `Ar', `Fl', and `Li', only do
954: * this once per invocation. There may be more
955: * of these (all of them?).
956: */
957: if (0 == cnt && (nc || MDOC_Li == tok) &&
958: DELIM_CLOSE == d && ! scope) {
1.76 schwarze 959: if ( ! mdoc_elem_alloc(mdoc, line,
960: ppos, tok, arg))
1.45 schwarze 961: return(0);
962: if (MDOC_Ar == tok || MDOC_Li == tok ||
963: MDOC_Fl == tok)
964: cnt++;
965: scope = 1;
966: }
967: /*
968: * Close out our scope, if one is open, before
969: * any punctuation.
970: */
1.76 schwarze 971: if (scope && ! rew_elem(mdoc, tok))
1.1 kristaps 972: return(0);
1.45 schwarze 973: scope = 0;
974: } else if ( ! scope) {
1.76 schwarze 975: if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1.1 kristaps 976: return(0);
1.45 schwarze 977: scope = 1;
1.1 kristaps 978: }
979:
1.40 schwarze 980: if (DELIM_NONE == d)
1.1 kristaps 981: cnt++;
1.66 schwarze 982:
1.80 schwarze 983: if ( ! dword(mdoc, line, la, p, d,
984: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 985: return(0);
1.27 schwarze 986:
987: /*
988: * `Fl' macros have their scope re-opened with each new
989: * word so that the `-' can be added to each one without
990: * having to parse out spaces.
991: */
1.45 schwarze 992: if (scope && MDOC_Fl == tok) {
1.76 schwarze 993: if ( ! rew_elem(mdoc, tok))
1.27 schwarze 994: return(0);
1.45 schwarze 995: scope = 0;
1.27 schwarze 996: }
1.1 kristaps 997: }
998:
1.76 schwarze 999: if (scope && ! rew_elem(mdoc, tok))
1.1 kristaps 1000: return(0);
1001:
1002: /*
1003: * If no elements have been collected and we're allowed to have
1004: * empties (nc), open a scope and close it out. Otherwise,
1005: * raise a warning.
1006: */
1.32 schwarze 1007:
1.1 kristaps 1008: if (nc && 0 == cnt) {
1.76 schwarze 1009: if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1.1 kristaps 1010: return(0);
1.76 schwarze 1011: if ( ! rew_last(mdoc, mdoc->last))
1.3 schwarze 1012: return(0);
1013: } else if ( ! nc && 0 == cnt) {
1.1 kristaps 1014: mdoc_argv_free(arg);
1.76 schwarze 1015: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_MACROEMPTY);
1.1 kristaps 1016: }
1017:
1.37 schwarze 1018: if ( ! nl)
1.1 kristaps 1019: return(1);
1.76 schwarze 1020: return(append_delims(mdoc, line, pos, buf));
1.1 kristaps 1021: }
1022:
1023:
1024: static int
1025: blk_full(MACRO_PROT_ARGS)
1026: {
1.73 schwarze 1027: int la, nl, nparsed;
1.1 kristaps 1028: struct mdoc_arg *arg;
1.32 schwarze 1029: struct mdoc_node *head; /* save of head macro */
1.34 schwarze 1030: struct mdoc_node *body; /* save of body macro */
1.32 schwarze 1031: struct mdoc_node *n;
1.46 schwarze 1032: enum mdoc_type mtt;
1.36 schwarze 1033: enum mdoct ntok;
1.37 schwarze 1034: enum margserr ac, lac;
1.36 schwarze 1035: enum margverr av;
1.1 kristaps 1036: char *p;
1037:
1.76 schwarze 1038: nl = MDOC_NEWLINE & mdoc->flags;
1.43 schwarze 1039:
1.32 schwarze 1040: /* Close out prior implicit scope. */
1.12 schwarze 1041:
1.1 kristaps 1042: if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
1.76 schwarze 1043: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.1 kristaps 1044: return(0);
1.76 schwarze 1045: if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.1 kristaps 1046: return(0);
1047: }
1048:
1.32 schwarze 1049: /*
1.68 schwarze 1050: * This routine accommodates implicitly- and explicitly-scoped
1.32 schwarze 1051: * macro openings. Implicit ones first close out prior scope
1052: * (seen above). Delay opening the head until necessary to
1053: * allow leading punctuation to print. Special consideration
1054: * for `It -column', which has phrase-part syntax instead of
1055: * regular child nodes.
1056: */
1057:
1.1 kristaps 1058: for (arg = NULL;; ) {
1.32 schwarze 1059: la = *pos;
1.76 schwarze 1060: av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1 kristaps 1061:
1.36 schwarze 1062: if (ARGV_WORD == av) {
1.32 schwarze 1063: *pos = la;
1.1 kristaps 1064: break;
1065: }
1066:
1.36 schwarze 1067: if (ARGV_EOLN == av)
1.1 kristaps 1068: break;
1.36 schwarze 1069: if (ARGV_ARG == av)
1.1 kristaps 1070: continue;
1071:
1072: mdoc_argv_free(arg);
1073: return(0);
1074: }
1075:
1.76 schwarze 1076: if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg))
1.1 kristaps 1077: return(0);
1078:
1.34 schwarze 1079: head = body = NULL;
1.1 kristaps 1080:
1.32 schwarze 1081: /*
1.73 schwarze 1082: * Exception: Heads of `It' macros in `-diag' lists are not
1083: * parsed, even though `It' macros in general are parsed.
1084: */
1085: nparsed = MDOC_It == tok &&
1.76 schwarze 1086: MDOC_Bl == mdoc->last->parent->tok &&
1087: LIST_diag == mdoc->last->parent->norm->Bl.type;
1.73 schwarze 1088:
1089: /*
1.32 schwarze 1090: * The `Nd' macro has all arguments in its body: it's a hybrid
1091: * of block partial-explicit and full-implicit. Stupid.
1092: */
1.12 schwarze 1093:
1.32 schwarze 1094: if (MDOC_Nd == tok) {
1.76 schwarze 1095: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.32 schwarze 1096: return(0);
1.76 schwarze 1097: head = mdoc->last;
1098: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.12 schwarze 1099: return(0);
1.76 schwarze 1100: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.12 schwarze 1101: return(0);
1.76 schwarze 1102: body = mdoc->last;
1.80 schwarze 1103: }
1104:
1105: if (MDOC_Bk == tok)
1106: mdoc->flags |= MDOC_KEEP;
1.12 schwarze 1107:
1.37 schwarze 1108: ac = ARGS_ERROR;
1109:
1.41 schwarze 1110: for ( ; ; ) {
1.32 schwarze 1111: la = *pos;
1.46 schwarze 1112: /* Initialise last-phrase-type with ARGS_PEND. */
1113: lac = ARGS_ERROR == ac ? ARGS_PEND : ac;
1.76 schwarze 1114: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.52 schwarze 1115:
1116: if (ARGS_PUNCT == ac)
1117: break;
1.1 kristaps 1118:
1.36 schwarze 1119: if (ARGS_ERROR == ac)
1.1 kristaps 1120: return(0);
1.46 schwarze 1121:
1122: if (ARGS_EOLN == ac) {
1123: if (ARGS_PPHRASE != lac && ARGS_PHRASE != lac)
1124: break;
1125: /*
1126: * This is necessary: if the last token on a
1127: * line is a `Ta' or tab, then we'll get
1128: * ARGS_EOLN, so we must be smart enough to
1129: * reopen our scope if the last parse was a
1130: * phrase or partial phrase.
1131: */
1.76 schwarze 1132: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.46 schwarze 1133: return(0);
1.76 schwarze 1134: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.46 schwarze 1135: return(0);
1.76 schwarze 1136: body = mdoc->last;
1.1 kristaps 1137: break;
1.41 schwarze 1138: }
1139:
1.46 schwarze 1140: /*
1141: * Emit leading punctuation (i.e., punctuation before
1142: * the MDOC_HEAD) for non-phrase types.
1143: */
1.32 schwarze 1144:
1.37 schwarze 1145: if (NULL == head &&
1.46 schwarze 1146: ARGS_PEND != ac &&
1.37 schwarze 1147: ARGS_PHRASE != ac &&
1.36 schwarze 1148: ARGS_PPHRASE != ac &&
1149: ARGS_QWORD != ac &&
1.66 schwarze 1150: DELIM_OPEN == mdoc_isdelim(p)) {
1.80 schwarze 1151: if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1.32 schwarze 1152: return(0);
1153: continue;
1154: }
1155:
1.46 schwarze 1156: /* Open a head if one hasn't been opened. */
1.32 schwarze 1157:
1.46 schwarze 1158: if (NULL == head) {
1.76 schwarze 1159: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1160: return(0);
1.76 schwarze 1161: head = mdoc->last;
1.32 schwarze 1162: }
1163:
1.46 schwarze 1164: if (ARGS_PHRASE == ac ||
1165: ARGS_PEND == ac ||
1166: ARGS_PPHRASE == ac) {
1167: /*
1168: * If we haven't opened a body yet, rewind the
1169: * head; if we have, rewind that instead.
1170: */
1171:
1172: mtt = body ? MDOC_BODY : MDOC_HEAD;
1.76 schwarze 1173: if ( ! rew_sub(mtt, mdoc, tok, line, ppos))
1.46 schwarze 1174: return(0);
1175:
1176: /* Then allocate our body context. */
1177:
1.76 schwarze 1178: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.46 schwarze 1179: return(0);
1.76 schwarze 1180: body = mdoc->last;
1.46 schwarze 1181:
1182: /*
1183: * Process phrases: set whether we're in a
1184: * partial-phrase (this effects line handling)
1185: * then call down into the phrase parser.
1186: */
1187:
1.41 schwarze 1188: if (ARGS_PPHRASE == ac)
1.76 schwarze 1189: mdoc->flags |= MDOC_PPHRASE;
1.46 schwarze 1190: if (ARGS_PEND == ac && ARGS_PPHRASE == lac)
1.76 schwarze 1191: mdoc->flags |= MDOC_PPHRASE;
1.46 schwarze 1192:
1.76 schwarze 1193: if ( ! phrase(mdoc, line, la, buf))
1.1 kristaps 1194: return(0);
1.46 schwarze 1195:
1.76 schwarze 1196: mdoc->flags &= ~MDOC_PPHRASE;
1.1 kristaps 1197: continue;
1198: }
1199:
1.73 schwarze 1200: ntok = nparsed || ARGS_QWORD == ac ?
1201: MDOC_MAX : lookup(tok, p);
1.36 schwarze 1202:
1203: if (MDOC_MAX == ntok) {
1.80 schwarze 1204: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1205: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 1206: return(0);
1.36 schwarze 1207: continue;
1.32 schwarze 1208: }
1.36 schwarze 1209:
1.76 schwarze 1210: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.32 schwarze 1211: return(0);
1.36 schwarze 1212: break;
1.32 schwarze 1213: }
1.1 kristaps 1214:
1.32 schwarze 1215: if (NULL == head) {
1.76 schwarze 1216: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1217: return(0);
1.76 schwarze 1218: head = mdoc->last;
1.1 kristaps 1219: }
1220:
1.76 schwarze 1221: if (nl && ! append_delims(mdoc, line, pos, buf))
1.1 kristaps 1222: return(0);
1.12 schwarze 1223:
1.34 schwarze 1224: /* If we've already opened our body, exit now. */
1.32 schwarze 1225:
1.34 schwarze 1226: if (NULL != body)
1.46 schwarze 1227: goto out;
1.29 schwarze 1228:
1229: /*
1.34 schwarze 1230: * If there is an open (i.e., unvalidated) sub-block requiring
1231: * explicit close-out, postpone switching the current block from
1232: * head to body until the rew_sub() call closing out that
1233: * sub-block.
1.29 schwarze 1234: */
1.76 schwarze 1235: for (n = mdoc->last; n && n != head; n = n->parent) {
1.34 schwarze 1236: if (MDOC_BLOCK == n->type &&
1237: MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1238: ! (MDOC_VALID & n->flags)) {
1.29 schwarze 1239: n->pending = head;
1240: return(1);
1241: }
1242: }
1.54 schwarze 1243:
1.32 schwarze 1244: /* Close out scopes to remain in a consistent state. */
1.12 schwarze 1245:
1.76 schwarze 1246: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.1 kristaps 1247: return(0);
1.76 schwarze 1248: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1249: return(0);
1250:
1.46 schwarze 1251: out:
1.76 schwarze 1252: if ( ! (MDOC_FREECOL & mdoc->flags))
1.46 schwarze 1253: return(1);
1254:
1.76 schwarze 1255: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.46 schwarze 1256: return(0);
1.76 schwarze 1257: if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.46 schwarze 1258: return(0);
1259:
1.76 schwarze 1260: mdoc->flags &= ~MDOC_FREECOL;
1.1 kristaps 1261: return(1);
1262: }
1263:
1264:
1265: static int
1266: blk_part_imp(MACRO_PROT_ARGS)
1267: {
1.43 schwarze 1268: int la, nl;
1.36 schwarze 1269: enum mdoct ntok;
1270: enum margserr ac;
1.1 kristaps 1271: char *p;
1.32 schwarze 1272: struct mdoc_node *blk; /* saved block context */
1273: struct mdoc_node *body; /* saved body context */
1274: struct mdoc_node *n;
1.1 kristaps 1275:
1.76 schwarze 1276: nl = MDOC_NEWLINE & mdoc->flags;
1.43 schwarze 1277:
1.32 schwarze 1278: /*
1279: * A macro that spans to the end of the line. This is generally
1280: * (but not necessarily) called as the first macro. The block
1281: * has a head as the immediate child, which is always empty,
1282: * followed by zero or more opening punctuation nodes, then the
1283: * body (which may be empty, depending on the macro), then zero
1284: * or more closing punctuation nodes.
1285: */
1.22 schwarze 1286:
1.76 schwarze 1287: if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
1.22 schwarze 1288: return(0);
1.32 schwarze 1289:
1.76 schwarze 1290: blk = mdoc->last;
1.32 schwarze 1291:
1.76 schwarze 1292: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1293: return(0);
1.76 schwarze 1294: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.1 kristaps 1295: return(0);
1296:
1.32 schwarze 1297: /*
1298: * Open the body scope "on-demand", that is, after we've
1299: * processed all our the leading delimiters (open parenthesis,
1300: * etc.).
1301: */
1.1 kristaps 1302:
1.32 schwarze 1303: for (body = NULL; ; ) {
1.22 schwarze 1304: la = *pos;
1.76 schwarze 1305: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.32 schwarze 1306:
1.36 schwarze 1307: if (ARGS_ERROR == ac)
1.1 kristaps 1308: return(0);
1.36 schwarze 1309: if (ARGS_EOLN == ac)
1.32 schwarze 1310: break;
1.36 schwarze 1311: if (ARGS_PUNCT == ac)
1.1 kristaps 1312: break;
1313:
1.36 schwarze 1314: if (NULL == body && ARGS_QWORD != ac &&
1.66 schwarze 1315: DELIM_OPEN == mdoc_isdelim(p)) {
1.80 schwarze 1316: if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1.1 kristaps 1317: return(0);
1318: continue;
1.80 schwarze 1319: }
1.1 kristaps 1320:
1.32 schwarze 1321: if (NULL == body) {
1.76 schwarze 1322: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.32 schwarze 1323: return(0);
1.76 schwarze 1324: body = mdoc->last;
1.32 schwarze 1325: }
1326:
1.36 schwarze 1327: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1328:
1329: if (MDOC_MAX == ntok) {
1.80 schwarze 1330: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1331: MDOC_JOIN & mdoc_macros[tok].flags))
1.32 schwarze 1332: return(0);
1.36 schwarze 1333: continue;
1334: }
1.32 schwarze 1335:
1.76 schwarze 1336: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.32 schwarze 1337: return(0);
1.36 schwarze 1338: break;
1.32 schwarze 1339: }
1340:
1341: /* Clean-ups to leave in a consistent state. */
1342:
1343: if (NULL == body) {
1.76 schwarze 1344: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1345: return(0);
1.76 schwarze 1346: body = mdoc->last;
1.39 schwarze 1347: }
1348:
1349: for (n = body->child; n && n->next; n = n->next)
1350: /* Do nothing. */ ;
1351:
1352: /*
1353: * End of sentence spacing: if the last node is a text node and
1354: * has a trailing period, then mark it as being end-of-sentence.
1355: */
1356:
1357: if (n && MDOC_TEXT == n->type && n->string)
1.55 schwarze 1358: if (mandoc_eos(n->string, strlen(n->string), 1))
1.39 schwarze 1359: n->flags |= MDOC_EOS;
1360:
1.68 schwarze 1361: /* Up-propagate the end-of-space flag. */
1.39 schwarze 1362:
1363: if (n && (MDOC_EOS & n->flags)) {
1364: body->flags |= MDOC_EOS;
1365: body->parent->flags |= MDOC_EOS;
1.1 kristaps 1366: }
1367:
1.47 schwarze 1368: /*
1369: * If there is an open sub-block requiring explicit close-out,
1370: * postpone closing out the current block
1371: * until the rew_sub() call closing out the sub-block.
1372: */
1.76 schwarze 1373: for (n = mdoc->last; n && n != body && n != blk->parent;
1374: n = n->parent) {
1.47 schwarze 1375: if (MDOC_BLOCK == n->type &&
1376: MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1377: ! (MDOC_VALID & n->flags)) {
1.76 schwarze 1378: make_pending(n, tok, mdoc, line, ppos);
1379: if ( ! mdoc_endbody_alloc(mdoc, line, ppos,
1.47 schwarze 1380: tok, body, ENDBODY_NOSPACE))
1381: return(0);
1382: return(1);
1383: }
1384: }
1385:
1.22 schwarze 1386: /*
1387: * If we can't rewind to our body, then our scope has already
1388: * been closed by another macro (like `Oc' closing `Op'). This
1389: * is ugly behaviour nodding its head to OpenBSD's overwhelming
1.34 schwarze 1390: * crufty use of `Op' breakage.
1.1 kristaps 1391: */
1.65 schwarze 1392: if (n != body)
1.76 schwarze 1393: mandoc_vmsg(MANDOCERR_SCOPENEST, mdoc->parse, line, ppos,
1.65 schwarze 1394: "%s broken", mdoc_macronames[tok]);
1.32 schwarze 1395:
1.76 schwarze 1396: if (n && ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.22 schwarze 1397: return(0);
1.1 kristaps 1398:
1.22 schwarze 1399: /* Standard appending of delimiters. */
1.1 kristaps 1400:
1.76 schwarze 1401: if (nl && ! append_delims(mdoc, line, pos, buf))
1.1 kristaps 1402: return(0);
1403:
1.22 schwarze 1404: /* Rewind scope, if applicable. */
1.1 kristaps 1405:
1.76 schwarze 1406: if (n && ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.1 kristaps 1407: return(0);
1.74 schwarze 1408:
1409: /* Move trailing .Ns out of scope. */
1410:
1411: for (n = body->child; n && n->next; n = n->next)
1412: /* Do nothing. */ ;
1413: if (n && MDOC_Ns == n->tok)
1.76 schwarze 1414: mdoc_node_relink(mdoc, n);
1.1 kristaps 1415:
1416: return(1);
1417: }
1418:
1419:
1420: static int
1421: blk_part_exp(MACRO_PROT_ARGS)
1422: {
1.37 schwarze 1423: int la, nl;
1.36 schwarze 1424: enum margserr ac;
1.32 schwarze 1425: struct mdoc_node *head; /* keep track of head */
1426: struct mdoc_node *body; /* keep track of body */
1.1 kristaps 1427: char *p;
1.36 schwarze 1428: enum mdoct ntok;
1.1 kristaps 1429:
1.76 schwarze 1430: nl = MDOC_NEWLINE & mdoc->flags;
1.37 schwarze 1431:
1.32 schwarze 1432: /*
1433: * The opening of an explicit macro having zero or more leading
1434: * punctuation nodes; a head with optional single element (the
1435: * case of `Eo'); and a body that may be empty.
1436: */
1.22 schwarze 1437:
1.76 schwarze 1438: if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
1.1 kristaps 1439: return(0);
1.22 schwarze 1440:
1.32 schwarze 1441: for (head = body = NULL; ; ) {
1.22 schwarze 1442: la = *pos;
1.76 schwarze 1443: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 1444:
1.36 schwarze 1445: if (ARGS_ERROR == ac)
1.1 kristaps 1446: return(0);
1.36 schwarze 1447: if (ARGS_PUNCT == ac)
1.1 kristaps 1448: break;
1.36 schwarze 1449: if (ARGS_EOLN == ac)
1.1 kristaps 1450: break;
1451:
1.32 schwarze 1452: /* Flush out leading punctuation. */
1453:
1.36 schwarze 1454: if (NULL == head && ARGS_QWORD != ac &&
1.66 schwarze 1455: DELIM_OPEN == mdoc_isdelim(p)) {
1.32 schwarze 1456: assert(NULL == body);
1.80 schwarze 1457: if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1.32 schwarze 1458: return(0);
1459: continue;
1.80 schwarze 1460: }
1.32 schwarze 1461:
1462: if (NULL == head) {
1463: assert(NULL == body);
1.76 schwarze 1464: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1465: return(0);
1.76 schwarze 1466: head = mdoc->last;
1.1 kristaps 1467: }
1468:
1.32 schwarze 1469: /*
1470: * `Eo' gobbles any data into the head, but most other
1471: * macros just immediately close out and begin the body.
1472: */
1473:
1474: if (NULL == body) {
1475: assert(head);
1476: /* No check whether it's a macro! */
1477: if (MDOC_Eo == tok)
1.80 schwarze 1478: if ( ! dword(mdoc, line, la, p, DELIM_MAX, 0))
1.32 schwarze 1479: return(0);
1480:
1.76 schwarze 1481: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.1 kristaps 1482: return(0);
1.76 schwarze 1483: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1484: return(0);
1.76 schwarze 1485: body = mdoc->last;
1.32 schwarze 1486:
1487: if (MDOC_Eo == tok)
1488: continue;
1489: }
1490:
1491: assert(NULL != head && NULL != body);
1492:
1.36 schwarze 1493: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1494:
1495: if (MDOC_MAX == ntok) {
1.80 schwarze 1496: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1497: MDOC_JOIN & mdoc_macros[tok].flags))
1.32 schwarze 1498: return(0);
1.36 schwarze 1499: continue;
1.1 kristaps 1500: }
1.32 schwarze 1501:
1.76 schwarze 1502: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.1 kristaps 1503: return(0);
1.36 schwarze 1504: break;
1.1 kristaps 1505: }
1506:
1.32 schwarze 1507: /* Clean-up to leave in a consistent state. */
1508:
1.70 schwarze 1509: if (NULL == head)
1.76 schwarze 1510: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.32 schwarze 1511: return(0);
1.22 schwarze 1512:
1.32 schwarze 1513: if (NULL == body) {
1.76 schwarze 1514: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.1 kristaps 1515: return(0);
1.76 schwarze 1516: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1517: return(0);
1518: }
1519:
1.22 schwarze 1520: /* Standard appending of delimiters. */
1521:
1.37 schwarze 1522: if ( ! nl)
1.1 kristaps 1523: return(1);
1.76 schwarze 1524: return(append_delims(mdoc, line, pos, buf));
1.1 kristaps 1525: }
1526:
1527:
1.37 schwarze 1528: /* ARGSUSED */
1.1 kristaps 1529: static int
1530: in_line_argn(MACRO_PROT_ARGS)
1531: {
1.37 schwarze 1532: int la, flushed, j, maxargs, nl;
1.36 schwarze 1533: enum margserr ac;
1534: enum margverr av;
1535: struct mdoc_arg *arg;
1536: char *p;
1537: enum mdoct ntok;
1.1 kristaps 1538:
1.76 schwarze 1539: nl = MDOC_NEWLINE & mdoc->flags;
1.37 schwarze 1540:
1.32 schwarze 1541: /*
1542: * A line macro that has a fixed number of arguments (maxargs).
1543: * Only open the scope once the first non-leading-punctuation is
1544: * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1545: * keep it open until the maximum number of arguments are
1546: * exhausted.
1547: */
1.1 kristaps 1548:
1549: switch (tok) {
1550: case (MDOC_Ap):
1551: /* FALLTHROUGH */
1552: case (MDOC_No):
1553: /* FALLTHROUGH */
1554: case (MDOC_Ns):
1555: /* FALLTHROUGH */
1556: case (MDOC_Ux):
1557: maxargs = 0;
1558: break;
1.64 schwarze 1559: case (MDOC_Bx):
1560: /* FALLTHROUGH */
1.28 schwarze 1561: case (MDOC_Xr):
1562: maxargs = 2;
1563: break;
1.1 kristaps 1564: default:
1565: maxargs = 1;
1566: break;
1567: }
1568:
1.32 schwarze 1569: for (arg = NULL; ; ) {
1.22 schwarze 1570: la = *pos;
1.76 schwarze 1571: av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1 kristaps 1572:
1.36 schwarze 1573: if (ARGV_WORD == av) {
1.22 schwarze 1574: *pos = la;
1.1 kristaps 1575: break;
1576: }
1577:
1.36 schwarze 1578: if (ARGV_EOLN == av)
1.1 kristaps 1579: break;
1.36 schwarze 1580: if (ARGV_ARG == av)
1.1 kristaps 1581: continue;
1582:
1583: mdoc_argv_free(arg);
1584: return(0);
1585: }
1586:
1.32 schwarze 1587: for (flushed = j = 0; ; ) {
1.22 schwarze 1588: la = *pos;
1.76 schwarze 1589: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 1590:
1.36 schwarze 1591: if (ARGS_ERROR == ac)
1.1 kristaps 1592: return(0);
1.36 schwarze 1593: if (ARGS_PUNCT == ac)
1.1 kristaps 1594: break;
1.36 schwarze 1595: if (ARGS_EOLN == ac)
1.1 kristaps 1596: break;
1597:
1.32 schwarze 1598: if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1.66 schwarze 1599: ARGS_QWORD != ac && 0 == j &&
1600: DELIM_OPEN == mdoc_isdelim(p)) {
1.80 schwarze 1601: if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1.32 schwarze 1602: return(0);
1603: continue;
1.40 schwarze 1604: } else if (0 == j)
1.76 schwarze 1605: if ( ! mdoc_elem_alloc(mdoc, line, la, tok, arg))
1.32 schwarze 1606: return(0);
1607:
1608: if (j == maxargs && ! flushed) {
1.76 schwarze 1609: if ( ! rew_elem(mdoc, tok))
1.32 schwarze 1610: return(0);
1611: flushed = 1;
1612: }
1613:
1.36 schwarze 1614: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1615:
1616: if (MDOC_MAX != ntok) {
1.76 schwarze 1617: if ( ! flushed && ! rew_elem(mdoc, tok))
1.1 kristaps 1618: return(0);
1619: flushed = 1;
1.76 schwarze 1620: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.1 kristaps 1621: return(0);
1.32 schwarze 1622: j++;
1.1 kristaps 1623: break;
1624: }
1625:
1626: if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1.36 schwarze 1627: ARGS_QWORD != ac &&
1.40 schwarze 1628: ! flushed &&
1.66 schwarze 1629: DELIM_NONE != mdoc_isdelim(p)) {
1.76 schwarze 1630: if ( ! rew_elem(mdoc, tok))
1.1 kristaps 1631: return(0);
1632: flushed = 1;
1.28 schwarze 1633: }
1634:
1.80 schwarze 1635: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1636: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 1637: return(0);
1.32 schwarze 1638: j++;
1.1 kristaps 1639: }
1640:
1.76 schwarze 1641: if (0 == j && ! mdoc_elem_alloc(mdoc, line, la, tok, arg))
1.32 schwarze 1642: return(0);
1643:
1644: /* Close out in a consistent state. */
1.22 schwarze 1645:
1.76 schwarze 1646: if ( ! flushed && ! rew_elem(mdoc, tok))
1.1 kristaps 1647: return(0);
1.37 schwarze 1648: if ( ! nl)
1.1 kristaps 1649: return(1);
1.76 schwarze 1650: return(append_delims(mdoc, line, pos, buf));
1.1 kristaps 1651: }
1652:
1653:
1654: static int
1655: in_line_eoln(MACRO_PROT_ARGS)
1656: {
1.36 schwarze 1657: int la;
1658: enum margserr ac;
1659: enum margverr av;
1660: struct mdoc_arg *arg;
1661: char *p;
1662: enum mdoct ntok;
1.1 kristaps 1663:
1664: assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
1665:
1.53 schwarze 1666: if (tok == MDOC_Pp)
1.76 schwarze 1667: rew_sub(MDOC_BLOCK, mdoc, MDOC_Nm, line, ppos);
1.53 schwarze 1668:
1.22 schwarze 1669: /* Parse macro arguments. */
1.1 kristaps 1670:
1.22 schwarze 1671: for (arg = NULL; ; ) {
1.1 kristaps 1672: la = *pos;
1.76 schwarze 1673: av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1 kristaps 1674:
1.36 schwarze 1675: if (ARGV_WORD == av) {
1.1 kristaps 1676: *pos = la;
1677: break;
1678: }
1.36 schwarze 1679: if (ARGV_EOLN == av)
1.1 kristaps 1680: break;
1.36 schwarze 1681: if (ARGV_ARG == av)
1.1 kristaps 1682: continue;
1683:
1684: mdoc_argv_free(arg);
1685: return(0);
1686: }
1687:
1.22 schwarze 1688: /* Open element scope. */
1689:
1.76 schwarze 1690: if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1.1 kristaps 1691: return(0);
1692:
1.22 schwarze 1693: /* Parse argument terms. */
1.1 kristaps 1694:
1695: for (;;) {
1696: la = *pos;
1.76 schwarze 1697: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 1698:
1.36 schwarze 1699: if (ARGS_ERROR == ac)
1.1 kristaps 1700: return(0);
1.36 schwarze 1701: if (ARGS_EOLN == ac)
1.1 kristaps 1702: break;
1703:
1.36 schwarze 1704: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1.1 kristaps 1705:
1.36 schwarze 1706: if (MDOC_MAX == ntok) {
1.80 schwarze 1707: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1708: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 1709: return(0);
1.36 schwarze 1710: continue;
1711: }
1.1 kristaps 1712:
1.76 schwarze 1713: if ( ! rew_elem(mdoc, tok))
1.1 kristaps 1714: return(0);
1.76 schwarze 1715: return(mdoc_macro(mdoc, ntok, line, la, pos, buf));
1.1 kristaps 1716: }
1717:
1.22 schwarze 1718: /* Close out (no delimiters). */
1719:
1.76 schwarze 1720: return(rew_elem(mdoc, tok));
1.28 schwarze 1721: }
1722:
1723:
1724: /* ARGSUSED */
1725: static int
1726: ctx_synopsis(MACRO_PROT_ARGS)
1727: {
1.37 schwarze 1728: int nl;
1729:
1.76 schwarze 1730: nl = MDOC_NEWLINE & mdoc->flags;
1.28 schwarze 1731:
1732: /* If we're not in the SYNOPSIS, go straight to in-line. */
1.76 schwarze 1733: if ( ! (MDOC_SYNOPSIS & mdoc->flags))
1734: return(in_line(mdoc, tok, line, ppos, pos, buf));
1.28 schwarze 1735:
1736: /* If we're a nested call, same place. */
1.37 schwarze 1737: if ( ! nl)
1.76 schwarze 1738: return(in_line(mdoc, tok, line, ppos, pos, buf));
1.28 schwarze 1739:
1740: /*
1741: * XXX: this will open a block scope; however, if later we end
1742: * up formatting the block scope, then child nodes will inherit
1743: * the formatting. Be careful.
1744: */
1.51 schwarze 1745: if (MDOC_Nm == tok)
1.76 schwarze 1746: return(blk_full(mdoc, tok, line, ppos, pos, buf));
1.51 schwarze 1747: assert(MDOC_Vt == tok);
1.76 schwarze 1748: return(blk_part_imp(mdoc, tok, line, ppos, pos, buf));
1.1 kristaps 1749: }
1750:
1751:
1752: /* ARGSUSED */
1753: static int
1754: obsolete(MACRO_PROT_ARGS)
1755: {
1756:
1.76 schwarze 1757: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_MACROOBS);
1.65 schwarze 1758: return(1);
1.1 kristaps 1759: }
1760:
1761:
1.17 schwarze 1762: /*
1763: * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1764: * They're unusual because they're basically free-form text until a
1765: * macro is encountered.
1766: */
1.1 kristaps 1767: static int
1.76 schwarze 1768: phrase(struct mdoc *mdoc, int line, int ppos, char *buf)
1.1 kristaps 1769: {
1.36 schwarze 1770: int la, pos;
1.46 schwarze 1771: enum margserr ac;
1.36 schwarze 1772: enum mdoct ntok;
1773: char *p;
1.1 kristaps 1774:
1.17 schwarze 1775: for (pos = ppos; ; ) {
1776: la = pos;
1.1 kristaps 1777:
1.76 schwarze 1778: ac = mdoc_zargs(mdoc, line, &pos, buf, &p);
1.1 kristaps 1779:
1.46 schwarze 1780: if (ARGS_ERROR == ac)
1.17 schwarze 1781: return(0);
1.46 schwarze 1782: if (ARGS_EOLN == ac)
1.17 schwarze 1783: break;
1.1 kristaps 1784:
1.46 schwarze 1785: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
1.1 kristaps 1786:
1.36 schwarze 1787: if (MDOC_MAX == ntok) {
1.80 schwarze 1788: if ( ! dword(mdoc, line, la, p, DELIM_MAX, 1))
1.1 kristaps 1789: return(0);
1.36 schwarze 1790: continue;
1791: }
1.1 kristaps 1792:
1.76 schwarze 1793: if ( ! mdoc_macro(mdoc, ntok, line, la, &pos, buf))
1.1 kristaps 1794: return(0);
1.76 schwarze 1795: return(append_delims(mdoc, line, &pos, buf));
1.1 kristaps 1796: }
1797:
1798: return(1);
1799: }
1.17 schwarze 1800:
1801:
1.46 schwarze 1802: /* ARGSUSED */
1803: static int
1804: phrase_ta(MACRO_PROT_ARGS)
1805: {
1.78 schwarze 1806: struct mdoc_node *n;
1.46 schwarze 1807: int la;
1808: enum mdoct ntok;
1809: enum margserr ac;
1810: char *p;
1811:
1.78 schwarze 1812: /* Make sure we are in a column list or ignore this macro. */
1813: n = mdoc->last;
1814: while (NULL != n && MDOC_Bl != n->tok)
1815: n = n->parent;
1816: if (NULL == n || LIST_column != n->norm->Bl.type) {
1817: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_STRAYTA);
1818: return(1);
1819: }
1.46 schwarze 1820:
1.78 schwarze 1821: /* Advance to the next column. */
1.76 schwarze 1822: if ( ! rew_sub(MDOC_BODY, mdoc, MDOC_It, line, ppos))
1.46 schwarze 1823: return(0);
1.76 schwarze 1824: if ( ! mdoc_body_alloc(mdoc, line, ppos, MDOC_It))
1.46 schwarze 1825: return(0);
1826:
1827: for (;;) {
1828: la = *pos;
1.76 schwarze 1829: ac = mdoc_zargs(mdoc, line, pos, buf, &p);
1.46 schwarze 1830:
1831: if (ARGS_ERROR == ac)
1832: return(0);
1833: if (ARGS_EOLN == ac)
1834: break;
1835:
1836: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
1837:
1838: if (MDOC_MAX == ntok) {
1.80 schwarze 1839: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1840: MDOC_JOIN & mdoc_macros[tok].flags))
1.46 schwarze 1841: return(0);
1842: continue;
1843: }
1844:
1.76 schwarze 1845: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.46 schwarze 1846: return(0);
1.76 schwarze 1847: return(append_delims(mdoc, line, pos, buf));
1.46 schwarze 1848: }
1849:
1850: return(1);
1851: }