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