Annotation of src/usr.bin/mandoc/mdoc_macro.c, Revision 1.88
1.88 ! schwarze 1: /* $Id: mdoc_macro.c,v 1.87 2014/03/30 19:47:32 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 obsolete(MACRO_PROT_ARGS);
! 48: static int phrase_ta(MACRO_PROT_ARGS);
1.36 schwarze 49:
1.80 schwarze 50: static int dword(struct mdoc *, int, int, const char *,
51: enum mdelim, int);
1.88 ! schwarze 52: static int append_delims(struct mdoc *,
1.36 schwarze 53: int, int *, char *);
54: static enum mdoct lookup(enum mdoct, const char *);
55: static enum mdoct lookup_raw(const char *);
1.49 schwarze 56: static int make_pending(struct mdoc_node *, enum mdoct,
1.47 schwarze 57: struct mdoc *, int, int);
1.88 ! schwarze 58: static int phrase(struct mdoc *, int, int, char *);
! 59: static enum mdoct rew_alt(enum mdoct);
! 60: static enum rew rew_dohalt(enum mdoct, enum mdoc_type,
1.36 schwarze 61: const struct mdoc_node *);
1.88 ! schwarze 62: static int rew_elem(struct mdoc *, enum mdoct);
! 63: static int rew_last(struct mdoc *,
1.36 schwarze 64: 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 */
103: { obsolete, 0 }, /* Ot */
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.80 schwarze 147: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED |
148: MDOC_IGNDELIM | MDOC_JOIN }, /* No */
149: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED |
150: MDOC_IGNDELIM | MDOC_JOIN }, /* Ns */
1.1 kristaps 151: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
152: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
1.80 schwarze 153: { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
154: MDOC_EXPLICIT | MDOC_JOIN }, /* Pc */
1.35 schwarze 155: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
1.80 schwarze 156: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
157: MDOC_EXPLICIT | MDOC_JOIN }, /* Po */
158: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Pq */
159: { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
160: MDOC_EXPLICIT | MDOC_JOIN }, /* Qc */
161: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ql */
162: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
163: MDOC_EXPLICIT | MDOC_JOIN }, /* Qo */
164: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Qq */
165: { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Re */
1.1 kristaps 166: { blk_full, MDOC_EXPLICIT }, /* Rs */
1.80 schwarze 167: { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
168: MDOC_EXPLICIT | MDOC_JOIN }, /* Sc */
169: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
170: MDOC_EXPLICIT | MDOC_JOIN }, /* So */
171: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sq */
1.1 kristaps 172: { in_line_eoln, 0 }, /* Sm */
1.80 schwarze 173: { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sx */
174: { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sy */
1.1 kristaps 175: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
1.80 schwarze 176: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ux */
1.1 kristaps 177: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
178: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
1.80 schwarze 179: { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
180: { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
181: MDOC_EXPLICIT | MDOC_JOIN }, /* Fc */
182: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
183: MDOC_EXPLICIT | MDOC_JOIN }, /* Oo */
184: { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
185: MDOC_EXPLICIT | MDOC_JOIN }, /* Oc */
1.1 kristaps 186: { blk_full, MDOC_EXPLICIT }, /* Bk */
1.80 schwarze 187: { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ek */
1.1 kristaps 188: { in_line_eoln, 0 }, /* Bt */
189: { in_line_eoln, 0 }, /* Hf */
190: { obsolete, 0 }, /* Fr */
191: { in_line_eoln, 0 }, /* Ud */
1.45 schwarze 192: { in_line, 0 }, /* Lb */
1.80 schwarze 193: { in_line_eoln, 0 }, /* Lp */
194: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
195: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
196: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Brq */
197: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
198: MDOC_EXPLICIT | MDOC_JOIN }, /* Bro */
199: { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
200: MDOC_EXPLICIT | MDOC_JOIN }, /* Brc */
201: { in_line_eoln, MDOC_JOIN }, /* %C */
1.1 kristaps 202: { obsolete, 0 }, /* Es */
203: { obsolete, 0 }, /* En */
204: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
1.80 schwarze 205: { in_line_eoln, MDOC_JOIN }, /* %Q */
1.13 schwarze 206: { in_line_eoln, 0 }, /* br */
207: { in_line_eoln, 0 }, /* sp */
1.25 schwarze 208: { in_line_eoln, 0 }, /* %U */
1.80 schwarze 209: { phrase_ta, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ta */
1.87 schwarze 210: { in_line_eoln, 0 }, /* ll */
1.1 kristaps 211: };
212:
213: const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
214:
215:
216: /*
217: * This is called at the end of parsing. It must traverse up the tree,
218: * closing out open [implicit] scopes. Obviously, open explicit scopes
219: * are errors.
220: */
221: int
1.76 schwarze 222: mdoc_macroend(struct mdoc *mdoc)
1.1 kristaps 223: {
224: struct mdoc_node *n;
225:
226: /* Scan for open explicit scopes. */
227:
1.76 schwarze 228: n = MDOC_VALID & mdoc->last->flags ?
1.88 ! schwarze 229: mdoc->last->parent : mdoc->last;
1.1 kristaps 230:
1.56 schwarze 231: for ( ; n; n = n->parent)
232: if (MDOC_BLOCK == n->type &&
233: MDOC_EXPLICIT & mdoc_macros[n->tok].flags)
1.76 schwarze 234: mdoc_nmsg(mdoc, n, MANDOCERR_SCOPEEXIT);
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.48 schwarze 423: if (MDOC_Nd == p->tok || MDOC_Ss == p->tok ||
424: MDOC_Sh == p->tok)
425: return(REWIND_MORE);
1.1 kristaps 426: break;
427: default:
428: break;
429: }
430:
1.50 schwarze 431: /*
432: * Default block rewinding rules.
1.51 schwarze 433: * In particular, always skip block end markers,
434: * and let all blocks rewind Nm children.
1.50 schwarze 435: */
1.54 schwarze 436: if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok ||
1.51 schwarze 437: (MDOC_BLOCK == p->type &&
1.50 schwarze 438: ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)))
439: return(REWIND_MORE);
440:
441: /*
1.59 schwarze 442: * By default, closing out full blocks
443: * forces closing of broken explicit blocks,
444: * while closing out partial blocks
445: * allows delayed rewinding by default.
1.50 schwarze 446: */
1.59 schwarze 447: return (&blk_full == mdoc_macros[tok].fp ?
448: REWIND_FORCE : REWIND_LATER);
1.1 kristaps 449: }
450:
451: static int
1.34 schwarze 452: rew_elem(struct mdoc *mdoc, enum mdoct tok)
1.1 kristaps 453: {
454: struct mdoc_node *n;
455:
456: n = mdoc->last;
457: if (MDOC_ELEM != n->type)
458: n = n->parent;
459: assert(MDOC_ELEM == n->type);
460: assert(tok == n->tok);
461:
462: return(rew_last(mdoc, n));
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.76 schwarze 528: mandoc_vmsg(MANDOCERR_SCOPENEST, 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:
! 558: mandoc_vmsg(MANDOCERR_SCOPEBROKEN, mdoc->parse,
! 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.76 schwarze 574: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_NOSCOPE);
1.59 schwarze 575: return(1);
1.22 schwarze 576: }
1.48 schwarze 577: break;
1.1 kristaps 578: }
579:
580: assert(n);
1.76 schwarze 581: if ( ! rew_last(mdoc, n))
1.29 schwarze 582: return(0);
583:
584: /*
1.47 schwarze 585: * The current block extends an enclosing block.
586: * Now that the current block ends, close the enclosing block, too.
1.29 schwarze 587: */
1.47 schwarze 588: while (NULL != (n = n->pending)) {
1.76 schwarze 589: if ( ! rew_last(mdoc, n))
1.29 schwarze 590: return(0);
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:
622: if (DELIM_OPEN == d)
1.76 schwarze 623: mdoc->last->flags |= MDOC_DELIMO;
1.71 schwarze 624:
625: /*
626: * Closing delimiters only suppress the preceding space
627: * when they follow something, not when they start a new
628: * block or element, and not when they follow `No'.
629: *
630: * XXX Explicitly special-casing MDOC_No here feels
631: * like a layering violation. Find a better way
632: * and solve this in the code related to `No'!
633: */
634:
1.76 schwarze 635: else if (DELIM_CLOSE == d && mdoc->last->prev &&
1.88 ! schwarze 636: mdoc->last->prev->tok != MDOC_No &&
! 637: mdoc->last->parent->tok != MDOC_Fd)
1.76 schwarze 638: mdoc->last->flags |= MDOC_DELIMC;
1.66 schwarze 639:
640: return(1);
641: }
1.1 kristaps 642:
643: static int
1.76 schwarze 644: append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
1.1 kristaps 645: {
1.42 schwarze 646: int la;
1.36 schwarze 647: enum margserr ac;
1.1 kristaps 648: char *p;
649:
1.42 schwarze 650: if ('\0' == buf[*pos])
1.1 kristaps 651: return(1);
652:
653: for (;;) {
1.42 schwarze 654: la = *pos;
1.76 schwarze 655: ac = mdoc_zargs(mdoc, line, pos, buf, &p);
1.1 kristaps 656:
1.36 schwarze 657: if (ARGS_ERROR == ac)
1.1 kristaps 658: return(0);
1.36 schwarze 659: else if (ARGS_EOLN == ac)
1.1 kristaps 660: break;
1.42 schwarze 661:
1.80 schwarze 662: dword(mdoc, line, la, p, DELIM_MAX, 1);
1.43 schwarze 663:
1.42 schwarze 664: /*
665: * If we encounter end-of-sentence symbols, then trigger
666: * the double-space.
667: *
1.68 schwarze 668: * XXX: it's easy to allow this to propagate outward to
1.42 schwarze 669: * the last symbol, such that `. )' will cause the
670: * correct double-spacing. However, (1) groff isn't
671: * smart enough to do this and (2) it would require
672: * knowing which symbols break this behaviour, for
1.68 schwarze 673: * example, `. ;' shouldn't propagate the double-space.
1.42 schwarze 674: */
1.84 schwarze 675: if (mandoc_eos(p, strlen(p)))
1.76 schwarze 676: mdoc->last->flags |= MDOC_EOS;
1.1 kristaps 677: }
678:
679: return(1);
680: }
681:
682: /*
1.88 ! schwarze 683: * Close out block partial/full explicit.
1.1 kristaps 684: */
685: static int
686: blk_exp_close(MACRO_PROT_ARGS)
687: {
1.47 schwarze 688: struct mdoc_node *body; /* Our own body. */
689: struct mdoc_node *later; /* A sub-block starting later. */
690: struct mdoc_node *n; /* For searching backwards. */
691:
1.88 ! schwarze 692: int j, lastarg, maxargs, flushed, nl;
1.36 schwarze 693: enum margserr ac;
1.47 schwarze 694: enum mdoct atok, ntok;
1.1 kristaps 695: char *p;
696:
1.76 schwarze 697: nl = MDOC_NEWLINE & mdoc->flags;
1.37 schwarze 698:
1.1 kristaps 699: switch (tok) {
1.88 ! schwarze 700: case MDOC_Ec:
1.1 kristaps 701: maxargs = 1;
702: break;
1.88 ! schwarze 703: case MDOC_Ek:
1.82 schwarze 704: mdoc->flags &= ~MDOC_KEEP;
1.1 kristaps 705: default:
706: maxargs = 0;
707: break;
708: }
709:
1.47 schwarze 710: /*
711: * Search backwards for beginnings of blocks,
712: * both of our own and of pending sub-blocks.
713: */
714: atok = rew_alt(tok);
715: body = later = NULL;
1.76 schwarze 716: for (n = mdoc->last; n; n = n->parent) {
1.47 schwarze 717: if (MDOC_VALID & n->flags)
718: continue;
719:
720: /* Remember the start of our own body. */
721: if (MDOC_BODY == n->type && atok == n->tok) {
1.54 schwarze 722: if (ENDBODY_NOT == n->end)
1.47 schwarze 723: body = n;
724: continue;
725: }
726:
1.51 schwarze 727: if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok)
1.47 schwarze 728: continue;
729: if (atok == n->tok) {
730: assert(body);
731:
732: /*
733: * Found the start of our own block.
734: * When there is no pending sub block,
735: * just proceed to closing out.
736: */
737: if (NULL == later)
738: break;
739:
1.88 ! schwarze 740: /*
1.47 schwarze 741: * When there is a pending sub block,
742: * postpone closing out the current block
743: * until the rew_sub() closing out the sub-block.
744: */
1.76 schwarze 745: make_pending(later, tok, mdoc, line, ppos);
1.47 schwarze 746:
747: /*
748: * Mark the place where the formatting - but not
749: * the scope - of the current block ends.
750: */
1.76 schwarze 751: if ( ! mdoc_endbody_alloc(mdoc, line, ppos,
1.47 schwarze 752: atok, body, ENDBODY_SPACE))
753: return(0);
754: break;
755: }
756:
757: /*
758: * When finding an open sub block, remember the last
759: * open explicit block, or, in case there are only
760: * implicit ones, the first open implicit block.
761: */
762: if (later &&
763: MDOC_EXPLICIT & mdoc_macros[later->tok].flags)
764: continue;
1.75 schwarze 765: if (MDOC_It != n->tok)
1.47 schwarze 766: later = n;
767: }
768:
1.1 kristaps 769: if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
1.44 schwarze 770: /* FIXME: do this in validate */
1.88 ! schwarze 771: if (buf[*pos])
1.76 schwarze 772: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_ARGSLOST);
1.14 schwarze 773:
1.76 schwarze 774: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.14 schwarze 775: return(0);
1.76 schwarze 776: return(rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos));
1.1 kristaps 777: }
778:
1.76 schwarze 779: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.1 kristaps 780: return(0);
781:
1.88 ! schwarze 782: if (NULL == later && maxargs > 0)
1.76 schwarze 783: if ( ! mdoc_tail_alloc(mdoc, line, ppos, rew_alt(tok)))
1.1 kristaps 784: return(0);
785:
1.20 schwarze 786: for (flushed = j = 0; ; j++) {
1.1 kristaps 787: lastarg = *pos;
788:
789: if (j == maxargs && ! flushed) {
1.76 schwarze 790: if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.1 kristaps 791: return(0);
792: flushed = 1;
793: }
794:
1.76 schwarze 795: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 796:
1.36 schwarze 797: if (ARGS_ERROR == ac)
1.1 kristaps 798: return(0);
1.36 schwarze 799: if (ARGS_PUNCT == ac)
1.1 kristaps 800: break;
1.36 schwarze 801: if (ARGS_EOLN == ac)
1.1 kristaps 802: break;
803:
1.36 schwarze 804: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
805:
806: if (MDOC_MAX == ntok) {
1.80 schwarze 807: if ( ! dword(mdoc, line, lastarg, p, DELIM_MAX,
808: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 809: return(0);
1.36 schwarze 810: continue;
811: }
1.1 kristaps 812:
1.36 schwarze 813: if ( ! flushed) {
1.76 schwarze 814: if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.36 schwarze 815: return(0);
816: flushed = 1;
817: }
1.79 schwarze 818:
819: mdoc->flags &= ~MDOC_NEWLINE;
820:
1.76 schwarze 821: if ( ! mdoc_macro(mdoc, ntok, line, lastarg, pos, buf))
1.1 kristaps 822: return(0);
1.36 schwarze 823: break;
1.1 kristaps 824: }
825:
1.76 schwarze 826: if ( ! flushed && ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.1 kristaps 827: return(0);
828:
1.37 schwarze 829: if ( ! nl)
1.1 kristaps 830: return(1);
1.76 schwarze 831: return(append_delims(mdoc, line, pos, buf));
1.1 kristaps 832: }
833:
834: static int
835: in_line(MACRO_PROT_ARGS)
836: {
1.45 schwarze 837: int la, scope, cnt, nc, nl;
1.36 schwarze 838: enum margverr av;
839: enum mdoct ntok;
840: enum margserr ac;
1.40 schwarze 841: enum mdelim d;
1.36 schwarze 842: struct mdoc_arg *arg;
843: char *p;
1.1 kristaps 844:
1.76 schwarze 845: nl = MDOC_NEWLINE & mdoc->flags;
1.37 schwarze 846:
1.1 kristaps 847: /*
848: * Whether we allow ignored elements (those without content,
849: * usually because of reserved words) to squeak by.
850: */
1.32 schwarze 851:
1.1 kristaps 852: switch (tok) {
1.88 ! schwarze 853: case MDOC_An:
1.19 schwarze 854: /* FALLTHROUGH */
1.88 ! schwarze 855: case MDOC_Ar:
1.1 kristaps 856: /* FALLTHROUGH */
1.88 ! schwarze 857: case MDOC_Fl:
1.1 kristaps 858: /* FALLTHROUGH */
1.88 ! schwarze 859: case MDOC_Mt:
1.18 schwarze 860: /* FALLTHROUGH */
1.88 ! schwarze 861: case MDOC_Nm:
1.19 schwarze 862: /* FALLTHROUGH */
1.88 ! schwarze 863: case MDOC_Pa:
1.1 kristaps 864: nc = 1;
865: break;
866: default:
867: nc = 0;
868: break;
869: }
870:
1.20 schwarze 871: for (arg = NULL;; ) {
1.1 kristaps 872: la = *pos;
1.76 schwarze 873: av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1 kristaps 874:
1.36 schwarze 875: if (ARGV_WORD == av) {
1.1 kristaps 876: *pos = la;
877: break;
1.88 ! schwarze 878: }
1.36 schwarze 879: if (ARGV_EOLN == av)
1.1 kristaps 880: break;
1.36 schwarze 881: if (ARGV_ARG == av)
1.1 kristaps 882: continue;
883:
884: mdoc_argv_free(arg);
885: return(0);
886: }
887:
1.45 schwarze 888: for (cnt = scope = 0;; ) {
1.1 kristaps 889: la = *pos;
1.76 schwarze 890: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 891:
1.36 schwarze 892: if (ARGS_ERROR == ac)
1.1 kristaps 893: return(0);
1.36 schwarze 894: if (ARGS_EOLN == ac)
1.1 kristaps 895: break;
1.36 schwarze 896: if (ARGS_PUNCT == ac)
1.1 kristaps 897: break;
898:
1.36 schwarze 899: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1.1 kristaps 900:
1.88 ! schwarze 901: /*
1.1 kristaps 902: * In this case, we've located a submacro and must
903: * execute it. Close out scope, if open. If no
904: * elements have been generated, either create one (nc)
905: * or raise a warning.
906: */
907:
1.36 schwarze 908: if (MDOC_MAX != ntok) {
1.76 schwarze 909: if (scope && ! rew_elem(mdoc, tok))
1.1 kristaps 910: return(0);
911: if (nc && 0 == cnt) {
1.88 ! schwarze 912: if ( ! mdoc_elem_alloc(mdoc,
! 913: line, ppos, tok, arg))
1.1 kristaps 914: return(0);
1.76 schwarze 915: if ( ! rew_last(mdoc, mdoc->last))
1.3 schwarze 916: return(0);
1.1 kristaps 917: } else if ( ! nc && 0 == cnt) {
918: mdoc_argv_free(arg);
1.76 schwarze 919: mdoc_pmsg(mdoc, line, ppos,
1.88 ! schwarze 920: MANDOCERR_MACROEMPTY);
1.1 kristaps 921: }
1.65 schwarze 922:
1.76 schwarze 923: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.1 kristaps 924: return(0);
1.37 schwarze 925: if ( ! nl)
1.1 kristaps 926: return(1);
1.76 schwarze 927: return(append_delims(mdoc, line, pos, buf));
1.88 ! schwarze 928: }
1.1 kristaps 929:
1.88 ! schwarze 930: /*
1.1 kristaps 931: * Non-quote-enclosed punctuation. Set up our scope, if
932: * a word; rewind the scope, if a delimiter; then append
1.88 ! schwarze 933: * the word.
1.1 kristaps 934: */
935:
1.66 schwarze 936: d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p);
1.1 kristaps 937:
1.45 schwarze 938: if (DELIM_NONE != d) {
939: /*
940: * If we encounter closing punctuation, no word
941: * has been omitted, no scope is open, and we're
942: * allowed to have an empty element, then start
943: * a new scope. `Ar', `Fl', and `Li', only do
944: * this once per invocation. There may be more
945: * of these (all of them?).
946: */
1.88 ! schwarze 947: if (0 == cnt && (nc || MDOC_Li == tok) &&
! 948: DELIM_CLOSE == d && ! scope) {
! 949: if ( ! mdoc_elem_alloc(mdoc,
! 950: line, ppos, tok, arg))
1.45 schwarze 951: return(0);
1.88 ! schwarze 952: if (MDOC_Ar == tok || MDOC_Li == tok ||
! 953: MDOC_Fl == tok)
1.45 schwarze 954: cnt++;
955: scope = 1;
956: }
957: /*
958: * Close out our scope, if one is open, before
959: * any punctuation.
960: */
1.76 schwarze 961: if (scope && ! rew_elem(mdoc, tok))
1.1 kristaps 962: return(0);
1.45 schwarze 963: scope = 0;
964: } else if ( ! scope) {
1.76 schwarze 965: if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1.1 kristaps 966: return(0);
1.45 schwarze 967: scope = 1;
1.1 kristaps 968: }
969:
1.40 schwarze 970: if (DELIM_NONE == d)
1.1 kristaps 971: cnt++;
1.66 schwarze 972:
1.80 schwarze 973: if ( ! dword(mdoc, line, la, p, d,
974: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 975: return(0);
1.27 schwarze 976:
977: /*
978: * `Fl' macros have their scope re-opened with each new
979: * word so that the `-' can be added to each one without
980: * having to parse out spaces.
981: */
1.45 schwarze 982: if (scope && MDOC_Fl == tok) {
1.76 schwarze 983: if ( ! rew_elem(mdoc, tok))
1.27 schwarze 984: return(0);
1.45 schwarze 985: scope = 0;
1.27 schwarze 986: }
1.1 kristaps 987: }
988:
1.76 schwarze 989: if (scope && ! rew_elem(mdoc, tok))
1.1 kristaps 990: return(0);
991:
992: /*
993: * If no elements have been collected and we're allowed to have
994: * empties (nc), open a scope and close it out. Otherwise,
995: * raise a warning.
996: */
1.32 schwarze 997:
1.1 kristaps 998: if (nc && 0 == cnt) {
1.76 schwarze 999: if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1.1 kristaps 1000: return(0);
1.76 schwarze 1001: if ( ! rew_last(mdoc, mdoc->last))
1.3 schwarze 1002: return(0);
1003: } else if ( ! nc && 0 == cnt) {
1.1 kristaps 1004: mdoc_argv_free(arg);
1.76 schwarze 1005: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_MACROEMPTY);
1.1 kristaps 1006: }
1007:
1.37 schwarze 1008: if ( ! nl)
1.1 kristaps 1009: return(1);
1.76 schwarze 1010: return(append_delims(mdoc, line, pos, buf));
1.1 kristaps 1011: }
1012:
1013: static int
1014: blk_full(MACRO_PROT_ARGS)
1015: {
1.73 schwarze 1016: int la, nl, nparsed;
1.1 kristaps 1017: struct mdoc_arg *arg;
1.32 schwarze 1018: struct mdoc_node *head; /* save of head macro */
1.34 schwarze 1019: struct mdoc_node *body; /* save of body macro */
1.32 schwarze 1020: struct mdoc_node *n;
1.46 schwarze 1021: enum mdoc_type mtt;
1.36 schwarze 1022: enum mdoct ntok;
1.37 schwarze 1023: enum margserr ac, lac;
1.36 schwarze 1024: enum margverr av;
1.1 kristaps 1025: char *p;
1026:
1.76 schwarze 1027: nl = MDOC_NEWLINE & mdoc->flags;
1.43 schwarze 1028:
1.32 schwarze 1029: /* Close out prior implicit scope. */
1.12 schwarze 1030:
1.1 kristaps 1031: if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
1.76 schwarze 1032: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.1 kristaps 1033: return(0);
1.76 schwarze 1034: if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.1 kristaps 1035: return(0);
1036: }
1037:
1.32 schwarze 1038: /*
1.68 schwarze 1039: * This routine accommodates implicitly- and explicitly-scoped
1.32 schwarze 1040: * macro openings. Implicit ones first close out prior scope
1041: * (seen above). Delay opening the head until necessary to
1042: * allow leading punctuation to print. Special consideration
1043: * for `It -column', which has phrase-part syntax instead of
1044: * regular child nodes.
1045: */
1046:
1.1 kristaps 1047: for (arg = NULL;; ) {
1.32 schwarze 1048: la = *pos;
1.76 schwarze 1049: av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1 kristaps 1050:
1.36 schwarze 1051: if (ARGV_WORD == av) {
1.32 schwarze 1052: *pos = la;
1.1 kristaps 1053: break;
1.88 ! schwarze 1054: }
1.1 kristaps 1055:
1.36 schwarze 1056: if (ARGV_EOLN == av)
1.1 kristaps 1057: break;
1.36 schwarze 1058: if (ARGV_ARG == av)
1.1 kristaps 1059: continue;
1060:
1061: mdoc_argv_free(arg);
1062: return(0);
1063: }
1064:
1.76 schwarze 1065: if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg))
1.1 kristaps 1066: return(0);
1067:
1.34 schwarze 1068: head = body = NULL;
1.1 kristaps 1069:
1.32 schwarze 1070: /*
1.73 schwarze 1071: * Exception: Heads of `It' macros in `-diag' lists are not
1072: * parsed, even though `It' macros in general are parsed.
1073: */
1074: nparsed = MDOC_It == tok &&
1.88 ! schwarze 1075: MDOC_Bl == mdoc->last->parent->tok &&
! 1076: LIST_diag == mdoc->last->parent->norm->Bl.type;
1.73 schwarze 1077:
1078: /*
1.32 schwarze 1079: * The `Nd' macro has all arguments in its body: it's a hybrid
1080: * of block partial-explicit and full-implicit. Stupid.
1081: */
1.12 schwarze 1082:
1.32 schwarze 1083: if (MDOC_Nd == tok) {
1.76 schwarze 1084: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.32 schwarze 1085: return(0);
1.76 schwarze 1086: head = mdoc->last;
1087: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.12 schwarze 1088: return(0);
1.76 schwarze 1089: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.12 schwarze 1090: return(0);
1.76 schwarze 1091: body = mdoc->last;
1.80 schwarze 1092: }
1093:
1094: if (MDOC_Bk == tok)
1095: mdoc->flags |= MDOC_KEEP;
1.12 schwarze 1096:
1.37 schwarze 1097: ac = ARGS_ERROR;
1098:
1.41 schwarze 1099: for ( ; ; ) {
1.32 schwarze 1100: la = *pos;
1.46 schwarze 1101: /* Initialise last-phrase-type with ARGS_PEND. */
1102: lac = ARGS_ERROR == ac ? ARGS_PEND : ac;
1.76 schwarze 1103: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.52 schwarze 1104:
1105: if (ARGS_PUNCT == ac)
1106: break;
1.1 kristaps 1107:
1.36 schwarze 1108: if (ARGS_ERROR == ac)
1.1 kristaps 1109: return(0);
1.46 schwarze 1110:
1111: if (ARGS_EOLN == ac) {
1112: if (ARGS_PPHRASE != lac && ARGS_PHRASE != lac)
1113: break;
1114: /*
1115: * This is necessary: if the last token on a
1116: * line is a `Ta' or tab, then we'll get
1117: * ARGS_EOLN, so we must be smart enough to
1118: * reopen our scope if the last parse was a
1119: * phrase or partial phrase.
1120: */
1.76 schwarze 1121: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.46 schwarze 1122: return(0);
1.76 schwarze 1123: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.46 schwarze 1124: return(0);
1.76 schwarze 1125: body = mdoc->last;
1.1 kristaps 1126: break;
1.41 schwarze 1127: }
1128:
1.88 ! schwarze 1129: /*
1.46 schwarze 1130: * Emit leading punctuation (i.e., punctuation before
1131: * the MDOC_HEAD) for non-phrase types.
1132: */
1.32 schwarze 1133:
1.88 ! schwarze 1134: if (NULL == head &&
! 1135: ARGS_PEND != ac &&
! 1136: ARGS_PHRASE != ac &&
! 1137: ARGS_PPHRASE != ac &&
! 1138: ARGS_QWORD != ac &&
! 1139: DELIM_OPEN == mdoc_isdelim(p)) {
1.80 schwarze 1140: if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1.32 schwarze 1141: return(0);
1142: continue;
1143: }
1144:
1.46 schwarze 1145: /* Open a head if one hasn't been opened. */
1.32 schwarze 1146:
1.46 schwarze 1147: if (NULL == head) {
1.76 schwarze 1148: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1149: return(0);
1.76 schwarze 1150: head = mdoc->last;
1.32 schwarze 1151: }
1152:
1.88 ! schwarze 1153: if (ARGS_PHRASE == ac ||
! 1154: ARGS_PEND == ac ||
! 1155: ARGS_PPHRASE == ac) {
1.46 schwarze 1156: /*
1157: * If we haven't opened a body yet, rewind the
1158: * head; if we have, rewind that instead.
1159: */
1160:
1161: mtt = body ? MDOC_BODY : MDOC_HEAD;
1.76 schwarze 1162: if ( ! rew_sub(mtt, mdoc, tok, line, ppos))
1.46 schwarze 1163: return(0);
1.88 ! schwarze 1164:
1.46 schwarze 1165: /* Then allocate our body context. */
1166:
1.76 schwarze 1167: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.46 schwarze 1168: return(0);
1.76 schwarze 1169: body = mdoc->last;
1.46 schwarze 1170:
1171: /*
1172: * Process phrases: set whether we're in a
1173: * partial-phrase (this effects line handling)
1174: * then call down into the phrase parser.
1175: */
1176:
1.41 schwarze 1177: if (ARGS_PPHRASE == ac)
1.76 schwarze 1178: mdoc->flags |= MDOC_PPHRASE;
1.46 schwarze 1179: if (ARGS_PEND == ac && ARGS_PPHRASE == lac)
1.76 schwarze 1180: mdoc->flags |= MDOC_PPHRASE;
1.46 schwarze 1181:
1.76 schwarze 1182: if ( ! phrase(mdoc, line, la, buf))
1.1 kristaps 1183: return(0);
1.46 schwarze 1184:
1.76 schwarze 1185: mdoc->flags &= ~MDOC_PPHRASE;
1.1 kristaps 1186: continue;
1187: }
1188:
1.88 ! schwarze 1189: ntok = nparsed || ARGS_QWORD == ac ?
! 1190: MDOC_MAX : lookup(tok, p);
1.36 schwarze 1191:
1192: if (MDOC_MAX == ntok) {
1.80 schwarze 1193: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1194: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 1195: return(0);
1.36 schwarze 1196: continue;
1.32 schwarze 1197: }
1.36 schwarze 1198:
1.76 schwarze 1199: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.32 schwarze 1200: return(0);
1.36 schwarze 1201: break;
1.32 schwarze 1202: }
1.1 kristaps 1203:
1.32 schwarze 1204: if (NULL == head) {
1.76 schwarze 1205: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1206: return(0);
1.76 schwarze 1207: head = mdoc->last;
1.1 kristaps 1208: }
1.88 ! schwarze 1209:
1.76 schwarze 1210: if (nl && ! append_delims(mdoc, line, pos, buf))
1.1 kristaps 1211: return(0);
1.12 schwarze 1212:
1.34 schwarze 1213: /* If we've already opened our body, exit now. */
1.32 schwarze 1214:
1.34 schwarze 1215: if (NULL != body)
1.46 schwarze 1216: goto out;
1.29 schwarze 1217:
1218: /*
1.34 schwarze 1219: * If there is an open (i.e., unvalidated) sub-block requiring
1220: * explicit close-out, postpone switching the current block from
1221: * head to body until the rew_sub() call closing out that
1222: * sub-block.
1.29 schwarze 1223: */
1.76 schwarze 1224: for (n = mdoc->last; n && n != head; n = n->parent) {
1.88 ! schwarze 1225: if (MDOC_BLOCK == n->type &&
! 1226: MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
! 1227: ! (MDOC_VALID & n->flags)) {
1.29 schwarze 1228: n->pending = head;
1229: return(1);
1230: }
1231: }
1.54 schwarze 1232:
1.32 schwarze 1233: /* Close out scopes to remain in a consistent state. */
1.12 schwarze 1234:
1.76 schwarze 1235: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.1 kristaps 1236: return(0);
1.76 schwarze 1237: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1238: return(0);
1239:
1.46 schwarze 1240: out:
1.76 schwarze 1241: if ( ! (MDOC_FREECOL & mdoc->flags))
1.46 schwarze 1242: return(1);
1243:
1.76 schwarze 1244: if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.46 schwarze 1245: return(0);
1.76 schwarze 1246: if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.46 schwarze 1247: return(0);
1248:
1.76 schwarze 1249: mdoc->flags &= ~MDOC_FREECOL;
1.1 kristaps 1250: return(1);
1251: }
1252:
1253: static int
1254: blk_part_imp(MACRO_PROT_ARGS)
1255: {
1.43 schwarze 1256: int la, nl;
1.36 schwarze 1257: enum mdoct ntok;
1258: enum margserr ac;
1.1 kristaps 1259: char *p;
1.32 schwarze 1260: struct mdoc_node *blk; /* saved block context */
1261: struct mdoc_node *body; /* saved body context */
1262: struct mdoc_node *n;
1.1 kristaps 1263:
1.76 schwarze 1264: nl = MDOC_NEWLINE & mdoc->flags;
1.43 schwarze 1265:
1.32 schwarze 1266: /*
1267: * A macro that spans to the end of the line. This is generally
1268: * (but not necessarily) called as the first macro. The block
1269: * has a head as the immediate child, which is always empty,
1270: * followed by zero or more opening punctuation nodes, then the
1271: * body (which may be empty, depending on the macro), then zero
1272: * or more closing punctuation nodes.
1273: */
1.22 schwarze 1274:
1.76 schwarze 1275: if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
1.22 schwarze 1276: return(0);
1.32 schwarze 1277:
1.76 schwarze 1278: blk = mdoc->last;
1.32 schwarze 1279:
1.76 schwarze 1280: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1281: return(0);
1.76 schwarze 1282: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.1 kristaps 1283: return(0);
1284:
1.32 schwarze 1285: /*
1286: * Open the body scope "on-demand", that is, after we've
1287: * processed all our the leading delimiters (open parenthesis,
1288: * etc.).
1289: */
1.1 kristaps 1290:
1.32 schwarze 1291: for (body = NULL; ; ) {
1.22 schwarze 1292: la = *pos;
1.76 schwarze 1293: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.32 schwarze 1294:
1.36 schwarze 1295: if (ARGS_ERROR == ac)
1.1 kristaps 1296: return(0);
1.36 schwarze 1297: if (ARGS_EOLN == ac)
1.32 schwarze 1298: break;
1.36 schwarze 1299: if (ARGS_PUNCT == ac)
1.1 kristaps 1300: break;
1301:
1.36 schwarze 1302: if (NULL == body && ARGS_QWORD != ac &&
1.88 ! schwarze 1303: DELIM_OPEN == mdoc_isdelim(p)) {
1.80 schwarze 1304: if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1.1 kristaps 1305: return(0);
1306: continue;
1.80 schwarze 1307: }
1.1 kristaps 1308:
1.32 schwarze 1309: if (NULL == body) {
1.76 schwarze 1310: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.32 schwarze 1311: return(0);
1.76 schwarze 1312: body = mdoc->last;
1.32 schwarze 1313: }
1314:
1.36 schwarze 1315: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1316:
1317: if (MDOC_MAX == ntok) {
1.80 schwarze 1318: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1319: MDOC_JOIN & mdoc_macros[tok].flags))
1.32 schwarze 1320: return(0);
1.36 schwarze 1321: continue;
1322: }
1.32 schwarze 1323:
1.76 schwarze 1324: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.32 schwarze 1325: return(0);
1.36 schwarze 1326: break;
1.32 schwarze 1327: }
1328:
1329: /* Clean-ups to leave in a consistent state. */
1330:
1331: if (NULL == body) {
1.76 schwarze 1332: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1333: return(0);
1.76 schwarze 1334: body = mdoc->last;
1.1 kristaps 1335: }
1336:
1.47 schwarze 1337: /*
1338: * If there is an open sub-block requiring explicit close-out,
1339: * postpone closing out the current block
1340: * until the rew_sub() call closing out the sub-block.
1341: */
1.76 schwarze 1342: for (n = mdoc->last; n && n != body && n != blk->parent;
1.88 ! schwarze 1343: n = n->parent) {
1.47 schwarze 1344: if (MDOC_BLOCK == n->type &&
1345: MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1346: ! (MDOC_VALID & n->flags)) {
1.76 schwarze 1347: make_pending(n, tok, mdoc, line, ppos);
1348: if ( ! mdoc_endbody_alloc(mdoc, line, ppos,
1.47 schwarze 1349: tok, body, ENDBODY_NOSPACE))
1350: return(0);
1351: return(1);
1352: }
1353: }
1354:
1.88 ! schwarze 1355: /*
1.22 schwarze 1356: * If we can't rewind to our body, then our scope has already
1357: * been closed by another macro (like `Oc' closing `Op'). This
1358: * is ugly behaviour nodding its head to OpenBSD's overwhelming
1.34 schwarze 1359: * crufty use of `Op' breakage.
1.1 kristaps 1360: */
1.65 schwarze 1361: if (n != body)
1.88 ! schwarze 1362: mandoc_vmsg(MANDOCERR_SCOPENEST, mdoc->parse, line,
! 1363: ppos, "%s broken", mdoc_macronames[tok]);
1.32 schwarze 1364:
1.76 schwarze 1365: if (n && ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos))
1.22 schwarze 1366: return(0);
1.1 kristaps 1367:
1.22 schwarze 1368: /* Standard appending of delimiters. */
1.1 kristaps 1369:
1.76 schwarze 1370: if (nl && ! append_delims(mdoc, line, pos, buf))
1.1 kristaps 1371: return(0);
1372:
1.22 schwarze 1373: /* Rewind scope, if applicable. */
1.1 kristaps 1374:
1.76 schwarze 1375: if (n && ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos))
1.1 kristaps 1376: return(0);
1.74 schwarze 1377:
1378: /* Move trailing .Ns out of scope. */
1379:
1380: for (n = body->child; n && n->next; n = n->next)
1381: /* Do nothing. */ ;
1382: if (n && MDOC_Ns == n->tok)
1.76 schwarze 1383: mdoc_node_relink(mdoc, n);
1.1 kristaps 1384:
1385: return(1);
1386: }
1387:
1388: static int
1389: blk_part_exp(MACRO_PROT_ARGS)
1390: {
1.37 schwarze 1391: int la, nl;
1.36 schwarze 1392: enum margserr ac;
1.32 schwarze 1393: struct mdoc_node *head; /* keep track of head */
1394: struct mdoc_node *body; /* keep track of body */
1.1 kristaps 1395: char *p;
1.36 schwarze 1396: enum mdoct ntok;
1.1 kristaps 1397:
1.76 schwarze 1398: nl = MDOC_NEWLINE & mdoc->flags;
1.37 schwarze 1399:
1.32 schwarze 1400: /*
1401: * The opening of an explicit macro having zero or more leading
1402: * punctuation nodes; a head with optional single element (the
1403: * case of `Eo'); and a body that may be empty.
1404: */
1.22 schwarze 1405:
1.76 schwarze 1406: if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
1.88 ! schwarze 1407: return(0);
1.22 schwarze 1408:
1.32 schwarze 1409: for (head = body = NULL; ; ) {
1.22 schwarze 1410: la = *pos;
1.76 schwarze 1411: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 1412:
1.36 schwarze 1413: if (ARGS_ERROR == ac)
1.1 kristaps 1414: return(0);
1.36 schwarze 1415: if (ARGS_PUNCT == ac)
1.1 kristaps 1416: break;
1.36 schwarze 1417: if (ARGS_EOLN == ac)
1.1 kristaps 1418: break;
1419:
1.32 schwarze 1420: /* Flush out leading punctuation. */
1421:
1.36 schwarze 1422: if (NULL == head && ARGS_QWORD != ac &&
1.88 ! schwarze 1423: DELIM_OPEN == mdoc_isdelim(p)) {
1.32 schwarze 1424: assert(NULL == body);
1.80 schwarze 1425: if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1.32 schwarze 1426: return(0);
1427: continue;
1.80 schwarze 1428: }
1.32 schwarze 1429:
1430: if (NULL == head) {
1431: assert(NULL == body);
1.76 schwarze 1432: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1433: return(0);
1.76 schwarze 1434: head = mdoc->last;
1.1 kristaps 1435: }
1436:
1.32 schwarze 1437: /*
1438: * `Eo' gobbles any data into the head, but most other
1439: * macros just immediately close out and begin the body.
1440: */
1441:
1442: if (NULL == body) {
1443: assert(head);
1444: /* No check whether it's a macro! */
1445: if (MDOC_Eo == tok)
1.80 schwarze 1446: if ( ! dword(mdoc, line, la, p, DELIM_MAX, 0))
1.32 schwarze 1447: return(0);
1448:
1.76 schwarze 1449: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.1 kristaps 1450: return(0);
1.76 schwarze 1451: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1452: return(0);
1.76 schwarze 1453: body = mdoc->last;
1.32 schwarze 1454:
1455: if (MDOC_Eo == tok)
1456: continue;
1457: }
1458:
1459: assert(NULL != head && NULL != body);
1460:
1.36 schwarze 1461: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1462:
1463: if (MDOC_MAX == ntok) {
1.80 schwarze 1464: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1465: MDOC_JOIN & mdoc_macros[tok].flags))
1.32 schwarze 1466: return(0);
1.36 schwarze 1467: continue;
1.1 kristaps 1468: }
1.32 schwarze 1469:
1.76 schwarze 1470: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.1 kristaps 1471: return(0);
1.36 schwarze 1472: break;
1.1 kristaps 1473: }
1474:
1.32 schwarze 1475: /* Clean-up to leave in a consistent state. */
1476:
1.70 schwarze 1477: if (NULL == head)
1.76 schwarze 1478: if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
1.32 schwarze 1479: return(0);
1.22 schwarze 1480:
1.32 schwarze 1481: if (NULL == body) {
1.76 schwarze 1482: if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos))
1.1 kristaps 1483: return(0);
1.76 schwarze 1484: if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
1.1 kristaps 1485: return(0);
1486: }
1487:
1.22 schwarze 1488: /* Standard appending of delimiters. */
1489:
1.37 schwarze 1490: if ( ! nl)
1.1 kristaps 1491: return(1);
1.76 schwarze 1492: return(append_delims(mdoc, line, pos, buf));
1.1 kristaps 1493: }
1494:
1495: static int
1496: in_line_argn(MACRO_PROT_ARGS)
1497: {
1.37 schwarze 1498: int la, flushed, j, maxargs, nl;
1.36 schwarze 1499: enum margserr ac;
1500: enum margverr av;
1501: struct mdoc_arg *arg;
1502: char *p;
1503: enum mdoct ntok;
1.1 kristaps 1504:
1.76 schwarze 1505: nl = MDOC_NEWLINE & mdoc->flags;
1.37 schwarze 1506:
1.32 schwarze 1507: /*
1508: * A line macro that has a fixed number of arguments (maxargs).
1509: * Only open the scope once the first non-leading-punctuation is
1510: * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1511: * keep it open until the maximum number of arguments are
1512: * exhausted.
1513: */
1.1 kristaps 1514:
1515: switch (tok) {
1.88 ! schwarze 1516: case MDOC_Ap:
1.1 kristaps 1517: /* FALLTHROUGH */
1.88 ! schwarze 1518: case MDOC_No:
1.1 kristaps 1519: /* FALLTHROUGH */
1.88 ! schwarze 1520: case MDOC_Ns:
1.1 kristaps 1521: /* FALLTHROUGH */
1.88 ! schwarze 1522: case MDOC_Ux:
1.1 kristaps 1523: maxargs = 0;
1524: break;
1.88 ! schwarze 1525: case MDOC_Bx:
1.64 schwarze 1526: /* FALLTHROUGH */
1.88 ! schwarze 1527: case MDOC_Xr:
1.28 schwarze 1528: maxargs = 2;
1529: break;
1.1 kristaps 1530: default:
1531: maxargs = 1;
1532: break;
1533: }
1534:
1.32 schwarze 1535: for (arg = NULL; ; ) {
1.22 schwarze 1536: la = *pos;
1.76 schwarze 1537: av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1 kristaps 1538:
1.36 schwarze 1539: if (ARGV_WORD == av) {
1.22 schwarze 1540: *pos = la;
1.1 kristaps 1541: break;
1.88 ! schwarze 1542: }
1.1 kristaps 1543:
1.36 schwarze 1544: if (ARGV_EOLN == av)
1.1 kristaps 1545: break;
1.36 schwarze 1546: if (ARGV_ARG == av)
1.1 kristaps 1547: continue;
1548:
1549: mdoc_argv_free(arg);
1550: return(0);
1551: }
1552:
1.32 schwarze 1553: for (flushed = j = 0; ; ) {
1.22 schwarze 1554: la = *pos;
1.76 schwarze 1555: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 1556:
1.36 schwarze 1557: if (ARGS_ERROR == ac)
1.1 kristaps 1558: return(0);
1.36 schwarze 1559: if (ARGS_PUNCT == ac)
1.1 kristaps 1560: break;
1.36 schwarze 1561: if (ARGS_EOLN == ac)
1.1 kristaps 1562: break;
1563:
1.88 ! schwarze 1564: if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
! 1565: ARGS_QWORD != ac && 0 == j &&
! 1566: DELIM_OPEN == mdoc_isdelim(p)) {
1.80 schwarze 1567: if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0))
1.32 schwarze 1568: return(0);
1569: continue;
1.40 schwarze 1570: } else if (0 == j)
1.76 schwarze 1571: if ( ! mdoc_elem_alloc(mdoc, line, la, tok, arg))
1.32 schwarze 1572: return(0);
1573:
1574: if (j == maxargs && ! flushed) {
1.76 schwarze 1575: if ( ! rew_elem(mdoc, tok))
1.32 schwarze 1576: return(0);
1577: flushed = 1;
1578: }
1579:
1.36 schwarze 1580: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1581:
1582: if (MDOC_MAX != ntok) {
1.76 schwarze 1583: if ( ! flushed && ! rew_elem(mdoc, tok))
1.1 kristaps 1584: return(0);
1585: flushed = 1;
1.76 schwarze 1586: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.1 kristaps 1587: return(0);
1.32 schwarze 1588: j++;
1.1 kristaps 1589: break;
1590: }
1591:
1592: if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1.88 ! schwarze 1593: ARGS_QWORD != ac &&
! 1594: ! flushed &&
! 1595: DELIM_NONE != mdoc_isdelim(p)) {
1.76 schwarze 1596: if ( ! rew_elem(mdoc, tok))
1.1 kristaps 1597: return(0);
1598: flushed = 1;
1.28 schwarze 1599: }
1600:
1.80 schwarze 1601: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1602: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 1603: return(0);
1.32 schwarze 1604: j++;
1.1 kristaps 1605: }
1606:
1.76 schwarze 1607: if (0 == j && ! mdoc_elem_alloc(mdoc, line, la, tok, arg))
1.32 schwarze 1608: return(0);
1609:
1610: /* Close out in a consistent state. */
1.22 schwarze 1611:
1.76 schwarze 1612: if ( ! flushed && ! rew_elem(mdoc, tok))
1.1 kristaps 1613: return(0);
1.37 schwarze 1614: if ( ! nl)
1.1 kristaps 1615: return(1);
1.76 schwarze 1616: return(append_delims(mdoc, line, pos, buf));
1.1 kristaps 1617: }
1618:
1619: static int
1620: in_line_eoln(MACRO_PROT_ARGS)
1621: {
1.36 schwarze 1622: int la;
1623: enum margserr ac;
1624: enum margverr av;
1625: struct mdoc_arg *arg;
1626: char *p;
1627: enum mdoct ntok;
1.1 kristaps 1628:
1629: assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
1630:
1.53 schwarze 1631: if (tok == MDOC_Pp)
1.76 schwarze 1632: rew_sub(MDOC_BLOCK, mdoc, MDOC_Nm, line, ppos);
1.53 schwarze 1633:
1.22 schwarze 1634: /* Parse macro arguments. */
1.1 kristaps 1635:
1.22 schwarze 1636: for (arg = NULL; ; ) {
1.1 kristaps 1637: la = *pos;
1.76 schwarze 1638: av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1 kristaps 1639:
1.36 schwarze 1640: if (ARGV_WORD == av) {
1.1 kristaps 1641: *pos = la;
1642: break;
1643: }
1.88 ! schwarze 1644: if (ARGV_EOLN == av)
1.1 kristaps 1645: break;
1.36 schwarze 1646: if (ARGV_ARG == av)
1.1 kristaps 1647: continue;
1648:
1649: mdoc_argv_free(arg);
1650: return(0);
1651: }
1652:
1.22 schwarze 1653: /* Open element scope. */
1654:
1.76 schwarze 1655: if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
1.1 kristaps 1656: return(0);
1657:
1.22 schwarze 1658: /* Parse argument terms. */
1.1 kristaps 1659:
1660: for (;;) {
1661: la = *pos;
1.76 schwarze 1662: ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1 kristaps 1663:
1.36 schwarze 1664: if (ARGS_ERROR == ac)
1.1 kristaps 1665: return(0);
1.36 schwarze 1666: if (ARGS_EOLN == ac)
1.1 kristaps 1667: break;
1668:
1.36 schwarze 1669: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1.1 kristaps 1670:
1.36 schwarze 1671: if (MDOC_MAX == ntok) {
1.80 schwarze 1672: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1673: MDOC_JOIN & mdoc_macros[tok].flags))
1.1 kristaps 1674: return(0);
1.36 schwarze 1675: continue;
1676: }
1.1 kristaps 1677:
1.76 schwarze 1678: if ( ! rew_elem(mdoc, tok))
1.1 kristaps 1679: return(0);
1.76 schwarze 1680: return(mdoc_macro(mdoc, ntok, line, la, pos, buf));
1.1 kristaps 1681: }
1682:
1.22 schwarze 1683: /* Close out (no delimiters). */
1684:
1.76 schwarze 1685: return(rew_elem(mdoc, tok));
1.28 schwarze 1686: }
1687:
1688: static int
1689: ctx_synopsis(MACRO_PROT_ARGS)
1690: {
1.37 schwarze 1691: int nl;
1692:
1.76 schwarze 1693: nl = MDOC_NEWLINE & mdoc->flags;
1.28 schwarze 1694:
1695: /* If we're not in the SYNOPSIS, go straight to in-line. */
1.76 schwarze 1696: if ( ! (MDOC_SYNOPSIS & mdoc->flags))
1697: return(in_line(mdoc, tok, line, ppos, pos, buf));
1.28 schwarze 1698:
1699: /* If we're a nested call, same place. */
1.37 schwarze 1700: if ( ! nl)
1.76 schwarze 1701: return(in_line(mdoc, tok, line, ppos, pos, buf));
1.28 schwarze 1702:
1703: /*
1704: * XXX: this will open a block scope; however, if later we end
1705: * up formatting the block scope, then child nodes will inherit
1706: * the formatting. Be careful.
1707: */
1.51 schwarze 1708: if (MDOC_Nm == tok)
1.76 schwarze 1709: return(blk_full(mdoc, tok, line, ppos, pos, buf));
1.51 schwarze 1710: assert(MDOC_Vt == tok);
1.76 schwarze 1711: return(blk_part_imp(mdoc, tok, line, ppos, pos, buf));
1.1 kristaps 1712: }
1713:
1714: static int
1715: obsolete(MACRO_PROT_ARGS)
1716: {
1717:
1.76 schwarze 1718: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_MACROOBS);
1.65 schwarze 1719: return(1);
1.1 kristaps 1720: }
1721:
1.17 schwarze 1722: /*
1723: * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1724: * They're unusual because they're basically free-form text until a
1725: * macro is encountered.
1726: */
1.1 kristaps 1727: static int
1.76 schwarze 1728: phrase(struct mdoc *mdoc, int line, int ppos, char *buf)
1.1 kristaps 1729: {
1.36 schwarze 1730: int la, pos;
1.46 schwarze 1731: enum margserr ac;
1.36 schwarze 1732: enum mdoct ntok;
1733: char *p;
1.1 kristaps 1734:
1.17 schwarze 1735: for (pos = ppos; ; ) {
1736: la = pos;
1.1 kristaps 1737:
1.76 schwarze 1738: ac = mdoc_zargs(mdoc, line, &pos, buf, &p);
1.1 kristaps 1739:
1.46 schwarze 1740: if (ARGS_ERROR == ac)
1.17 schwarze 1741: return(0);
1.46 schwarze 1742: if (ARGS_EOLN == ac)
1.17 schwarze 1743: break;
1.1 kristaps 1744:
1.46 schwarze 1745: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
1.1 kristaps 1746:
1.36 schwarze 1747: if (MDOC_MAX == ntok) {
1.80 schwarze 1748: if ( ! dword(mdoc, line, la, p, DELIM_MAX, 1))
1.1 kristaps 1749: return(0);
1.36 schwarze 1750: continue;
1751: }
1.1 kristaps 1752:
1.76 schwarze 1753: if ( ! mdoc_macro(mdoc, ntok, line, la, &pos, buf))
1.1 kristaps 1754: return(0);
1.76 schwarze 1755: return(append_delims(mdoc, line, &pos, buf));
1.1 kristaps 1756: }
1757:
1758: return(1);
1759: }
1.17 schwarze 1760:
1.46 schwarze 1761: static int
1762: phrase_ta(MACRO_PROT_ARGS)
1763: {
1.78 schwarze 1764: struct mdoc_node *n;
1.46 schwarze 1765: int la;
1766: enum mdoct ntok;
1767: enum margserr ac;
1768: char *p;
1769:
1.78 schwarze 1770: /* Make sure we are in a column list or ignore this macro. */
1771: n = mdoc->last;
1772: while (NULL != n && MDOC_Bl != n->tok)
1773: n = n->parent;
1774: if (NULL == n || LIST_column != n->norm->Bl.type) {
1775: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_STRAYTA);
1776: return(1);
1777: }
1.46 schwarze 1778:
1.78 schwarze 1779: /* Advance to the next column. */
1.76 schwarze 1780: if ( ! rew_sub(MDOC_BODY, mdoc, MDOC_It, line, ppos))
1.46 schwarze 1781: return(0);
1.76 schwarze 1782: if ( ! mdoc_body_alloc(mdoc, line, ppos, MDOC_It))
1.46 schwarze 1783: return(0);
1784:
1785: for (;;) {
1786: la = *pos;
1.76 schwarze 1787: ac = mdoc_zargs(mdoc, line, pos, buf, &p);
1.46 schwarze 1788:
1789: if (ARGS_ERROR == ac)
1790: return(0);
1791: if (ARGS_EOLN == ac)
1792: break;
1793:
1794: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
1795:
1796: if (MDOC_MAX == ntok) {
1.80 schwarze 1797: if ( ! dword(mdoc, line, la, p, DELIM_MAX,
1798: MDOC_JOIN & mdoc_macros[tok].flags))
1.46 schwarze 1799: return(0);
1800: continue;
1801: }
1802:
1.76 schwarze 1803: if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf))
1.46 schwarze 1804: return(0);
1.76 schwarze 1805: return(append_delims(mdoc, line, pos, buf));
1.46 schwarze 1806: }
1807:
1808: return(1);
1809: }
![[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