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