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