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