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