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