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