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