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