Annotation of mandoc/mdoc_macro.c, Revision 1.67
1.67 ! schwarze 1: /* $Id: mdoc_macro.c,v 1.66 2010/05/15 06:48:13 kristaps Exp $ */
1.1 kristaps 2: /*
1.9 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.8 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.8 kristaps 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 16: */
1.40 kristaps 17: #ifdef HAVE_CONFIG_H
18: #include "config.h"
19: #endif
20:
1.1 kristaps 21: #include <assert.h>
22: #include <ctype.h>
23: #include <stdlib.h>
24: #include <stdio.h>
25: #include <string.h>
1.38 kristaps 26: #include <time.h>
1.1 kristaps 27:
28: #include "libmdoc.h"
1.64 kristaps 29: #include "libmandoc.h"
1.1 kristaps 30:
1.51 kristaps 31: enum rew {
32: REWIND_REWIND,
33: REWIND_NOHALT,
34: REWIND_HALT
35: };
1.1 kristaps 36:
1.53 kristaps 37: static int blk_full(MACRO_PROT_ARGS);
38: static int blk_exp_close(MACRO_PROT_ARGS);
39: static int blk_part_exp(MACRO_PROT_ARGS);
40: static int blk_part_imp(MACRO_PROT_ARGS);
41: static int ctx_synopsis(MACRO_PROT_ARGS);
42: static int in_line_eoln(MACRO_PROT_ARGS);
43: static int in_line_argn(MACRO_PROT_ARGS);
44: static int in_line(MACRO_PROT_ARGS);
45: static int obsolete(MACRO_PROT_ARGS);
46:
47: static int append_delims(struct mdoc *,
48: int, int *, char *);
1.58 kristaps 49: static enum mdoct lookup(enum mdoct, const char *);
1.53 kristaps 50: static enum mdoct lookup_raw(const char *);
1.59 kristaps 51: static int phrase(struct mdoc *, int, int,
1.62 kristaps 52: char *, enum margserr);
1.53 kristaps 53: static enum mdoct rew_alt(enum mdoct);
54: static int rew_dobreak(enum mdoct,
55: const struct mdoc_node *);
56: static enum rew rew_dohalt(enum mdoct, enum mdoc_type,
57: const struct mdoc_node *);
58: static int rew_elem(struct mdoc *, enum mdoct);
59: static int rew_last(struct mdoc *,
60: const struct mdoc_node *);
61: static int rew_sub(enum mdoc_type, struct mdoc *,
62: enum mdoct, int, int);
63: static int swarn(struct mdoc *, enum mdoc_type, int,
64: int, const struct mdoc_node *);
1.1 kristaps 65:
66: const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
1.13 kristaps 67: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */
1.1 kristaps 68: { in_line_eoln, MDOC_PROLOGUE }, /* Dd */
69: { in_line_eoln, MDOC_PROLOGUE }, /* Dt */
70: { in_line_eoln, MDOC_PROLOGUE }, /* Os */
71: { blk_full, 0 }, /* Sh */
72: { blk_full, 0 }, /* Ss */
1.21 kristaps 73: { in_line_eoln, 0 }, /* Pp */
1.1 kristaps 74: { blk_part_imp, MDOC_PARSED }, /* D1 */
75: { blk_part_imp, MDOC_PARSED }, /* Dl */
76: { blk_full, MDOC_EXPLICIT }, /* Bd */
77: { blk_exp_close, MDOC_EXPLICIT }, /* Ed */
78: { blk_full, MDOC_EXPLICIT }, /* Bl */
79: { blk_exp_close, MDOC_EXPLICIT }, /* El */
80: { blk_full, MDOC_PARSED }, /* It */
81: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
1.10 kristaps 82: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* An */
1.1 kristaps 83: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
1.23 kristaps 84: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cd */
1.1 kristaps 85: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
86: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
87: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
88: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
89: { in_line_eoln, 0 }, /* Ex */
90: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */
91: { in_line_eoln, 0 }, /* Fd */
92: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
93: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */
1.11 kristaps 94: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */
1.1 kristaps 95: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */
1.18 kristaps 96: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */
1.1 kristaps 97: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
1.19 kristaps 98: { blk_full, 0 }, /* Nd */
1.1 kristaps 99: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
100: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
101: { obsolete, 0 }, /* Ot */
102: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
103: { in_line_eoln, 0 }, /* Rv */
104: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */
105: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
1.41 kristaps 106: { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
1.42 kristaps 107: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
1.1 kristaps 108: { in_line_eoln, 0 }, /* %A */
109: { in_line_eoln, 0 }, /* %B */
110: { in_line_eoln, 0 }, /* %D */
111: { in_line_eoln, 0 }, /* %I */
112: { in_line_eoln, 0 }, /* %J */
113: { in_line_eoln, 0 }, /* %N */
114: { in_line_eoln, 0 }, /* %O */
115: { in_line_eoln, 0 }, /* %P */
116: { in_line_eoln, 0 }, /* %R */
117: { in_line_eoln, 0 }, /* %T */
118: { in_line_eoln, 0 }, /* %V */
119: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
120: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */
121: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
122: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* At */
123: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
124: { blk_full, MDOC_EXPLICIT }, /* Bf */
125: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */
126: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */
127: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */
128: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */
129: { in_line_eoln, 0 }, /* Db */
130: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */
131: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */
132: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */
133: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
134: { blk_exp_close, MDOC_EXPLICIT }, /* Ef */
135: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Em */
136: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
137: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */
1.11 kristaps 138: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */
1.1 kristaps 139: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */
140: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */
141: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
142: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
143: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
1.52 kristaps 144: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
1.1 kristaps 145: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
146: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
147: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
148: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
149: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */
150: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
151: { blk_exp_close, MDOC_EXPLICIT }, /* Re */
152: { blk_full, MDOC_EXPLICIT }, /* Rs */
153: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
154: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* So */
155: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */
156: { in_line_eoln, 0 }, /* Sm */
157: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */
158: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */
159: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
160: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ux */
161: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
162: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
163: { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
164: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Fc */
165: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */
166: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */
167: { blk_full, MDOC_EXPLICIT }, /* Bk */
168: { blk_exp_close, MDOC_EXPLICIT }, /* Ek */
169: { in_line_eoln, 0 }, /* Bt */
170: { in_line_eoln, 0 }, /* Hf */
171: { obsolete, 0 }, /* Fr */
172: { in_line_eoln, 0 }, /* Ud */
173: { in_line_eoln, 0 }, /* Lb */
1.21 kristaps 174: { in_line_eoln, 0 }, /* Lp */
1.12 kristaps 175: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
176: { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
1.1 kristaps 177: { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */
178: { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */
179: { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */
180: { in_line_eoln, 0 }, /* %C */
181: { obsolete, 0 }, /* Es */
182: { obsolete, 0 }, /* En */
183: { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
184: { in_line_eoln, 0 }, /* %Q */
1.20 kristaps 185: { in_line_eoln, 0 }, /* br */
186: { in_line_eoln, 0 }, /* sp */
1.37 kristaps 187: { in_line_eoln, 0 }, /* %U */
1.1 kristaps 188: };
189:
190: const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
191:
192:
193: static int
194: swarn(struct mdoc *mdoc, enum mdoc_type type,
195: int line, int pos, const struct mdoc_node *p)
196: {
197: const char *n, *t, *tt;
198:
199: n = t = "<root>";
200: tt = "block";
201:
202: switch (type) {
203: case (MDOC_BODY):
204: tt = "multi-line";
205: break;
206: case (MDOC_HEAD):
207: tt = "line";
208: break;
209: default:
210: break;
211: }
212:
213: switch (p->type) {
214: case (MDOC_BLOCK):
215: n = mdoc_macronames[p->tok];
216: t = "block";
217: break;
218: case (MDOC_BODY):
219: n = mdoc_macronames[p->tok];
220: t = "multi-line";
221: break;
222: case (MDOC_HEAD):
223: n = mdoc_macronames[p->tok];
224: t = "line";
225: break;
226: default:
227: break;
228: }
229:
230: if ( ! (MDOC_IGN_SCOPE & mdoc->pflags))
1.16 kristaps 231: return(mdoc_verr(mdoc, line, pos,
1.1 kristaps 232: "%s scope breaks %s scope of %s",
233: tt, t, n));
1.16 kristaps 234: return(mdoc_vwarn(mdoc, line, pos,
1.1 kristaps 235: "%s scope breaks %s scope of %s",
236: tt, t, n));
237: }
238:
239:
240: /*
241: * This is called at the end of parsing. It must traverse up the tree,
242: * closing out open [implicit] scopes. Obviously, open explicit scopes
243: * are errors.
244: */
245: int
1.32 kristaps 246: mdoc_macroend(struct mdoc *m)
1.1 kristaps 247: {
248: struct mdoc_node *n;
249:
250: /* Scan for open explicit scopes. */
251:
1.32 kristaps 252: n = MDOC_VALID & m->last->flags ? m->last->parent : m->last;
1.1 kristaps 253:
254: for ( ; n; n = n->parent) {
255: if (MDOC_BLOCK != n->type)
256: continue;
257: if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags))
258: continue;
1.32 kristaps 259: return(mdoc_nerr(m, n, EOPEN));
1.1 kristaps 260: }
261:
1.32 kristaps 262: /* Rewind to the first. */
263:
264: return(rew_last(m, m->first));
1.1 kristaps 265: }
266:
1.32 kristaps 267:
268: /*
269: * Look up a macro from within a subsequent context.
270: */
1.53 kristaps 271: static enum mdoct
1.58 kristaps 272: lookup(enum mdoct from, const char *p)
1.28 kristaps 273: {
1.36 kristaps 274: /* FIXME: make -diag lists be un-PARSED. */
1.28 kristaps 275:
276: if ( ! (MDOC_PARSED & mdoc_macros[from].flags))
277: return(MDOC_MAX);
1.35 kristaps 278: return(lookup_raw(p));
1.28 kristaps 279: }
280:
281:
1.32 kristaps 282: /*
283: * Lookup a macro following the initial line macro.
284: */
1.53 kristaps 285: static enum mdoct
1.35 kristaps 286: lookup_raw(const char *p)
1.1 kristaps 287: {
1.58 kristaps 288: enum mdoct res;
1.1 kristaps 289:
1.34 kristaps 290: if (MDOC_MAX == (res = mdoc_hash_find(p)))
1.28 kristaps 291: return(MDOC_MAX);
292: if (MDOC_CALLABLE & mdoc_macros[res].flags)
1.1 kristaps 293: return(res);
294: return(MDOC_MAX);
295: }
296:
297:
298: static int
1.32 kristaps 299: rew_last(struct mdoc *mdoc, const struct mdoc_node *to)
1.1 kristaps 300: {
301:
302: assert(to);
303: mdoc->next = MDOC_NEXT_SIBLING;
304:
305: /* LINTED */
306: while (mdoc->last != to) {
307: if ( ! mdoc_valid_post(mdoc))
308: return(0);
309: if ( ! mdoc_action_post(mdoc))
310: return(0);
311: mdoc->last = mdoc->last->parent;
312: assert(mdoc->last);
313: }
314:
315: if ( ! mdoc_valid_post(mdoc))
316: return(0);
317: return(mdoc_action_post(mdoc));
318: }
319:
320:
1.32 kristaps 321: /*
322: * Return the opening macro of a closing one, e.g., `Ec' has `Eo' as its
323: * matching pair.
324: */
1.47 kristaps 325: static enum mdoct
326: rew_alt(enum mdoct tok)
1.1 kristaps 327: {
328: switch (tok) {
329: case (MDOC_Ac):
330: return(MDOC_Ao);
331: case (MDOC_Bc):
332: return(MDOC_Bo);
333: case (MDOC_Brc):
334: return(MDOC_Bro);
335: case (MDOC_Dc):
336: return(MDOC_Do);
337: case (MDOC_Ec):
338: return(MDOC_Eo);
339: case (MDOC_Ed):
340: return(MDOC_Bd);
341: case (MDOC_Ef):
342: return(MDOC_Bf);
343: case (MDOC_Ek):
344: return(MDOC_Bk);
345: case (MDOC_El):
346: return(MDOC_Bl);
347: case (MDOC_Fc):
348: return(MDOC_Fo);
349: case (MDOC_Oc):
350: return(MDOC_Oo);
351: case (MDOC_Pc):
352: return(MDOC_Po);
353: case (MDOC_Qc):
354: return(MDOC_Qo);
355: case (MDOC_Re):
356: return(MDOC_Rs);
357: case (MDOC_Sc):
358: return(MDOC_So);
359: case (MDOC_Xc):
360: return(MDOC_Xo);
361: default:
362: break;
363: }
364: abort();
365: /* NOTREACHED */
366: }
367:
368:
369: /*
370: * Rewind rules. This indicates whether to stop rewinding
371: * (REWIND_HALT) without touching our current scope, stop rewinding and
372: * close our current scope (REWIND_REWIND), or continue (REWIND_NOHALT).
373: * The scope-closing and so on occurs in the various rew_* routines.
374: */
1.51 kristaps 375: static enum rew
1.47 kristaps 376: rew_dohalt(enum mdoct tok, enum mdoc_type type,
377: const struct mdoc_node *p)
1.1 kristaps 378: {
379:
380: if (MDOC_ROOT == p->type)
381: return(REWIND_HALT);
382: if (MDOC_VALID & p->flags)
383: return(REWIND_NOHALT);
384:
385: switch (tok) {
386: case (MDOC_Aq):
387: /* FALLTHROUGH */
388: case (MDOC_Bq):
389: /* FALLTHROUGH */
390: case (MDOC_Brq):
391: /* FALLTHROUGH */
392: case (MDOC_D1):
393: /* FALLTHROUGH */
394: case (MDOC_Dl):
395: /* FALLTHROUGH */
396: case (MDOC_Dq):
397: /* FALLTHROUGH */
398: case (MDOC_Op):
399: /* FALLTHROUGH */
400: case (MDOC_Pq):
401: /* FALLTHROUGH */
402: case (MDOC_Ql):
403: /* FALLTHROUGH */
404: case (MDOC_Qq):
405: /* FALLTHROUGH */
406: case (MDOC_Sq):
1.41 kristaps 407: /* FALLTHROUGH */
408: case (MDOC_Vt):
1.1 kristaps 409: assert(MDOC_TAIL != type);
410: if (type == p->type && tok == p->tok)
411: return(REWIND_REWIND);
412: break;
413: case (MDOC_It):
414: assert(MDOC_TAIL != type);
415: if (type == p->type && tok == p->tok)
416: return(REWIND_REWIND);
417: if (MDOC_BODY == p->type && MDOC_Bl == p->tok)
418: return(REWIND_HALT);
419: break;
420: case (MDOC_Sh):
421: if (type == p->type && tok == p->tok)
422: return(REWIND_REWIND);
423: break;
1.19 kristaps 424: case (MDOC_Nd):
425: /* FALLTHROUGH */
1.1 kristaps 426: case (MDOC_Ss):
427: assert(MDOC_TAIL != type);
428: if (type == p->type && tok == p->tok)
429: return(REWIND_REWIND);
430: if (MDOC_BODY == p->type && MDOC_Sh == p->tok)
431: return(REWIND_HALT);
432: break;
433: case (MDOC_Ao):
434: /* FALLTHROUGH */
435: case (MDOC_Bd):
436: /* FALLTHROUGH */
437: case (MDOC_Bf):
438: /* FALLTHROUGH */
439: case (MDOC_Bk):
440: /* FALLTHROUGH */
441: case (MDOC_Bl):
442: /* FALLTHROUGH */
443: case (MDOC_Bo):
444: /* FALLTHROUGH */
445: case (MDOC_Bro):
446: /* FALLTHROUGH */
447: case (MDOC_Do):
448: /* FALLTHROUGH */
449: case (MDOC_Eo):
450: /* FALLTHROUGH */
451: case (MDOC_Fo):
452: /* FALLTHROUGH */
453: case (MDOC_Oo):
454: /* FALLTHROUGH */
455: case (MDOC_Po):
456: /* FALLTHROUGH */
457: case (MDOC_Qo):
458: /* FALLTHROUGH */
459: case (MDOC_Rs):
460: /* FALLTHROUGH */
461: case (MDOC_So):
462: /* FALLTHROUGH */
463: case (MDOC_Xo):
464: if (type == p->type && tok == p->tok)
465: return(REWIND_REWIND);
466: break;
467: /* Multi-line explicit scope close. */
468: case (MDOC_Ac):
469: /* FALLTHROUGH */
470: case (MDOC_Bc):
471: /* FALLTHROUGH */
472: case (MDOC_Brc):
473: /* FALLTHROUGH */
474: case (MDOC_Dc):
475: /* FALLTHROUGH */
476: case (MDOC_Ec):
477: /* FALLTHROUGH */
478: case (MDOC_Ed):
479: /* FALLTHROUGH */
480: case (MDOC_Ek):
481: /* FALLTHROUGH */
482: case (MDOC_El):
483: /* FALLTHROUGH */
484: case (MDOC_Fc):
485: /* FALLTHROUGH */
486: case (MDOC_Ef):
487: /* FALLTHROUGH */
488: case (MDOC_Oc):
489: /* FALLTHROUGH */
490: case (MDOC_Pc):
491: /* FALLTHROUGH */
492: case (MDOC_Qc):
493: /* FALLTHROUGH */
494: case (MDOC_Re):
495: /* FALLTHROUGH */
496: case (MDOC_Sc):
497: /* FALLTHROUGH */
498: case (MDOC_Xc):
499: if (type == p->type && rew_alt(tok) == p->tok)
500: return(REWIND_REWIND);
501: break;
502: default:
503: abort();
504: /* NOTREACHED */
505: }
506:
507: return(REWIND_NOHALT);
508: }
509:
510:
511: /*
512: * See if we can break an encountered scope (the rew_dohalt has returned
513: * REWIND_NOHALT).
514: */
515: static int
1.47 kristaps 516: rew_dobreak(enum mdoct tok, const struct mdoc_node *p)
1.1 kristaps 517: {
518:
519: assert(MDOC_ROOT != p->type);
520: if (MDOC_ELEM == p->type)
521: return(1);
522: if (MDOC_TEXT == p->type)
523: return(1);
524: if (MDOC_VALID & p->flags)
525: return(1);
526:
527: switch (tok) {
528: case (MDOC_It):
529: return(MDOC_It == p->tok);
1.19 kristaps 530: case (MDOC_Nd):
531: return(MDOC_Nd == p->tok);
1.1 kristaps 532: case (MDOC_Ss):
533: return(MDOC_Ss == p->tok);
534: case (MDOC_Sh):
1.19 kristaps 535: if (MDOC_Nd == p->tok)
536: return(1);
1.1 kristaps 537: if (MDOC_Ss == p->tok)
538: return(1);
539: return(MDOC_Sh == p->tok);
540: case (MDOC_El):
541: if (MDOC_It == p->tok)
542: return(1);
543: break;
544: case (MDOC_Oc):
545: if (MDOC_Op == p->tok)
546: return(1);
547: break;
548: default:
549: break;
550: }
551:
552: if (MDOC_EXPLICIT & mdoc_macros[tok].flags)
553: return(p->tok == rew_alt(tok));
554: else if (MDOC_BLOCK == p->type)
555: return(1);
556:
557: return(tok == p->tok);
558: }
559:
560:
561: static int
1.47 kristaps 562: rew_elem(struct mdoc *mdoc, enum mdoct tok)
1.1 kristaps 563: {
564: struct mdoc_node *n;
565:
566: n = mdoc->last;
567: if (MDOC_ELEM != n->type)
568: n = n->parent;
569: assert(MDOC_ELEM == n->type);
570: assert(tok == n->tok);
571:
572: return(rew_last(mdoc, n));
573: }
574:
575:
576: static int
1.32 kristaps 577: rew_sub(enum mdoc_type t, struct mdoc *m,
1.47 kristaps 578: enum mdoct tok, int line, int ppos)
1.1 kristaps 579: {
580: struct mdoc_node *n;
1.51 kristaps 581: enum rew c;
1.1 kristaps 582:
583: /* LINTED */
1.32 kristaps 584: for (n = m->last; n; n = n->parent) {
585: c = rew_dohalt(tok, t, n);
586: if (REWIND_HALT == c) {
587: if (MDOC_BLOCK != t)
588: return(1);
589: if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags))
590: return(1);
591: return(mdoc_perr(m, line, ppos, ENOCTX));
592: }
1.1 kristaps 593: if (REWIND_REWIND == c)
594: break;
595: else if (rew_dobreak(tok, n))
596: continue;
1.32 kristaps 597: if ( ! swarn(m, t, line, ppos, n))
1.1 kristaps 598: return(0);
599: }
600:
601: assert(n);
1.47 kristaps 602: if ( ! rew_last(m, n))
603: return(0);
604:
605: #ifdef UGLY
606: /*
607: * The current block extends an enclosing block beyond a line
608: * break. Now that the current block ends, close the enclosing
609: * block, too.
610: */
611: if (NULL != (n = n->pending)) {
612: assert(MDOC_HEAD == n->type);
613: if ( ! rew_last(m, n))
614: return(0);
615: if ( ! mdoc_body_alloc(m, n->line, n->pos, n->tok))
616: return(0);
617: }
618: #endif
619:
620: return(1);
1.1 kristaps 621: }
622:
623:
624: static int
1.66 kristaps 625: append_delims(struct mdoc *m, int line, int *pos, char *buf)
1.1 kristaps 626: {
1.66 kristaps 627: int la;
1.55 kristaps 628: enum margserr ac;
1.1 kristaps 629: char *p;
630:
1.66 kristaps 631: if ('\0' == buf[*pos])
1.1 kristaps 632: return(1);
633:
634: for (;;) {
1.66 kristaps 635: la = *pos;
636: ac = mdoc_zargs(m, line, pos, buf, ARGS_NOWARN, &p);
1.1 kristaps 637:
1.53 kristaps 638: if (ARGS_ERROR == ac)
1.1 kristaps 639: return(0);
1.53 kristaps 640: else if (ARGS_EOLN == ac)
1.1 kristaps 641: break;
1.66 kristaps 642:
1.67 ! schwarze 643: assert(DELIM_NONE != mdoc_isdelim(p));
1.66 kristaps 644: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 645: return(0);
1.66 kristaps 646:
647: /*
648: * If we encounter end-of-sentence symbols, then trigger
649: * the double-space.
650: *
651: * XXX: it's easy to allow this to propogate outward to
652: * the last symbol, such that `. )' will cause the
653: * correct double-spacing. However, (1) groff isn't
654: * smart enough to do this and (2) it would require
655: * knowing which symbols break this behaviour, for
656: * example, `. ;' shouldn't propogate the double-space.
657: */
658: if (mandoc_eos(p, strlen(p)))
659: m->last->flags |= MDOC_EOS;
1.1 kristaps 660: }
661:
662: return(1);
663: }
664:
665:
666: /*
667: * Close out block partial/full explicit.
668: */
669: static int
670: blk_exp_close(MACRO_PROT_ARGS)
671: {
1.60 kristaps 672: int j, lastarg, maxargs, flushed, nl;
1.55 kristaps 673: enum margserr ac;
1.53 kristaps 674: enum mdoct ntok;
1.1 kristaps 675: char *p;
676:
1.60 kristaps 677: nl = MDOC_NEWLINE & m->flags;
678:
1.1 kristaps 679: switch (tok) {
680: case (MDOC_Ec):
681: maxargs = 1;
682: break;
683: default:
684: maxargs = 0;
685: break;
686: }
687:
688: if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
1.22 kristaps 689: if (buf[*pos])
1.32 kristaps 690: if ( ! mdoc_pwarn(m, line, ppos, ENOLINE))
1.1 kristaps 691: return(0);
1.22 kristaps 692:
1.32 kristaps 693: if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
1.22 kristaps 694: return(0);
1.32 kristaps 695: return(rew_sub(MDOC_BLOCK, m, tok, line, ppos));
1.1 kristaps 696: }
697:
1.32 kristaps 698: if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
1.1 kristaps 699: return(0);
700:
1.32 kristaps 701: if (maxargs > 0)
702: if ( ! mdoc_tail_alloc(m, line, ppos, rew_alt(tok)))
1.1 kristaps 703: return(0);
704:
1.27 kristaps 705: for (flushed = j = 0; ; j++) {
1.1 kristaps 706: lastarg = *pos;
707:
708: if (j == maxargs && ! flushed) {
1.32 kristaps 709: if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
1.1 kristaps 710: return(0);
711: flushed = 1;
712: }
713:
1.53 kristaps 714: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 715:
1.53 kristaps 716: if (ARGS_ERROR == ac)
1.1 kristaps 717: return(0);
1.53 kristaps 718: if (ARGS_PUNCT == ac)
1.1 kristaps 719: break;
1.53 kristaps 720: if (ARGS_EOLN == ac)
1.1 kristaps 721: break;
722:
1.54 kristaps 723: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
724:
725: if (MDOC_MAX == ntok) {
726: if ( ! mdoc_word_alloc(m, line, lastarg, p))
1.1 kristaps 727: return(0);
1.54 kristaps 728: continue;
729: }
1.1 kristaps 730:
1.54 kristaps 731: if ( ! flushed) {
732: if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
733: return(0);
734: flushed = 1;
735: }
736: if ( ! mdoc_macro(m, ntok, line, lastarg, pos, buf))
1.1 kristaps 737: return(0);
1.54 kristaps 738: break;
1.1 kristaps 739: }
740:
1.32 kristaps 741: if ( ! flushed && ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
1.1 kristaps 742: return(0);
743:
1.60 kristaps 744: if ( ! nl)
1.1 kristaps 745: return(1);
1.32 kristaps 746: return(append_delims(m, line, pos, buf));
1.1 kristaps 747: }
748:
749:
750: static int
751: in_line(MACRO_PROT_ARGS)
752: {
1.67 ! schwarze 753: int la, lastpunct, cnt, nc, nl;
1.56 kristaps 754: enum margverr av;
1.53 kristaps 755: enum mdoct ntok;
1.55 kristaps 756: enum margserr ac;
1.67 ! schwarze 757: enum mdelim d;
1.53 kristaps 758: struct mdoc_arg *arg;
759: char *p;
1.1 kristaps 760:
1.60 kristaps 761: nl = MDOC_NEWLINE & m->flags;
762:
1.4 kristaps 763: /*
764: * Whether we allow ignored elements (those without content,
765: * usually because of reserved words) to squeak by.
766: */
1.45 kristaps 767:
1.4 kristaps 768: switch (tok) {
1.26 kristaps 769: case (MDOC_An):
770: /* FALLTHROUGH */
771: case (MDOC_Ar):
1.4 kristaps 772: /* FALLTHROUGH */
773: case (MDOC_Fl):
774: /* FALLTHROUGH */
1.12 kristaps 775: case (MDOC_Lk):
776: /* FALLTHROUGH */
1.26 kristaps 777: case (MDOC_Nm):
778: /* FALLTHROUGH */
1.25 kristaps 779: case (MDOC_Pa):
1.4 kristaps 780: nc = 1;
781: break;
782: default:
783: nc = 0;
784: break;
785: }
786:
1.27 kristaps 787: for (arg = NULL;; ) {
1.1 kristaps 788: la = *pos;
1.56 kristaps 789: av = mdoc_argv(m, line, tok, &arg, pos, buf);
1.1 kristaps 790:
1.56 kristaps 791: if (ARGV_WORD == av) {
1.1 kristaps 792: *pos = la;
793: break;
794: }
1.56 kristaps 795: if (ARGV_EOLN == av)
1.1 kristaps 796: break;
1.56 kristaps 797: if (ARGV_ARG == av)
1.1 kristaps 798: continue;
799:
800: mdoc_argv_free(arg);
801: return(0);
802: }
803:
1.4 kristaps 804: for (cnt = 0, lastpunct = 1;; ) {
1.1 kristaps 805: la = *pos;
1.53 kristaps 806: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 807:
1.53 kristaps 808: if (ARGS_ERROR == ac)
1.1 kristaps 809: return(0);
1.53 kristaps 810: if (ARGS_EOLN == ac)
1.1 kristaps 811: break;
1.53 kristaps 812: if (ARGS_PUNCT == ac)
1.1 kristaps 813: break;
814:
1.53 kristaps 815: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1.1 kristaps 816:
1.4 kristaps 817: /*
818: * In this case, we've located a submacro and must
819: * execute it. Close out scope, if open. If no
820: * elements have been generated, either create one (nc)
821: * or raise a warning.
822: */
1.1 kristaps 823:
1.53 kristaps 824: if (MDOC_MAX != ntok) {
1.32 kristaps 825: if (0 == lastpunct && ! rew_elem(m, tok))
1.1 kristaps 826: return(0);
1.4 kristaps 827: if (nc && 0 == cnt) {
1.32 kristaps 828: if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1.3 kristaps 829: return(0);
1.32 kristaps 830: if ( ! rew_last(m, m->last))
1.12 kristaps 831: return(0);
1.7 kristaps 832: } else if ( ! nc && 0 == cnt) {
833: mdoc_argv_free(arg);
1.32 kristaps 834: if ( ! mdoc_pwarn(m, line, ppos, EIGNE))
1.3 kristaps 835: return(0);
1.7 kristaps 836: }
1.53 kristaps 837: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.1 kristaps 838: return(0);
1.60 kristaps 839: if ( ! nl)
1.1 kristaps 840: return(1);
1.32 kristaps 841: return(append_delims(m, line, pos, buf));
1.29 kristaps 842: }
1.1 kristaps 843:
1.4 kristaps 844: /*
845: * Non-quote-enclosed punctuation. Set up our scope, if
846: * a word; rewind the scope, if a delimiter; then append
847: * the word.
848: */
1.1 kristaps 849:
1.67 ! schwarze 850: d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p);
1.3 kristaps 851:
1.67 ! schwarze 852: if (ARGS_QWORD != ac && DELIM_NONE != d) {
1.32 kristaps 853: if (0 == lastpunct && ! rew_elem(m, tok))
1.1 kristaps 854: return(0);
855: lastpunct = 1;
856: } else if (lastpunct) {
1.32 kristaps 857: if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1.1 kristaps 858: return(0);
859: lastpunct = 0;
860: }
861:
1.67 ! schwarze 862: if (DELIM_NONE == d)
1.3 kristaps 863: cnt++;
1.32 kristaps 864: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 865: return(0);
1.39 kristaps 866:
867: /*
868: * `Fl' macros have their scope re-opened with each new
869: * word so that the `-' can be added to each one without
870: * having to parse out spaces.
871: */
872: if (0 == lastpunct && MDOC_Fl == tok) {
873: if ( ! rew_elem(m, tok))
874: return(0);
875: lastpunct = 1;
876: }
1.1 kristaps 877: }
878:
1.32 kristaps 879: if (0 == lastpunct && ! rew_elem(m, tok))
1.1 kristaps 880: return(0);
1.4 kristaps 881:
882: /*
883: * If no elements have been collected and we're allowed to have
884: * empties (nc), open a scope and close it out. Otherwise,
885: * raise a warning.
886: */
1.45 kristaps 887:
1.4 kristaps 888: if (nc && 0 == cnt) {
1.32 kristaps 889: if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1.3 kristaps 890: return(0);
1.32 kristaps 891: if ( ! rew_last(m, m->last))
1.12 kristaps 892: return(0);
1.7 kristaps 893: } else if ( ! nc && 0 == cnt) {
894: mdoc_argv_free(arg);
1.32 kristaps 895: if ( ! mdoc_pwarn(m, line, ppos, EIGNE))
1.3 kristaps 896: return(0);
1.7 kristaps 897: }
1.4 kristaps 898:
1.60 kristaps 899: if ( ! nl)
1.1 kristaps 900: return(1);
1.32 kristaps 901: return(append_delims(m, line, pos, buf));
1.1 kristaps 902: }
903:
904:
905: static int
906: blk_full(MACRO_PROT_ARGS)
907: {
1.63 kristaps 908: int la, nl;
1.1 kristaps 909: struct mdoc_arg *arg;
1.45 kristaps 910: struct mdoc_node *head; /* save of head macro */
1.49 kristaps 911: struct mdoc_node *body; /* save of body macro */
1.48 kristaps 912: #ifdef UGLY
1.47 kristaps 913: struct mdoc_node *n;
1.48 kristaps 914: #endif
1.53 kristaps 915: enum mdoct ntok;
1.59 kristaps 916: enum margserr ac, lac;
1.56 kristaps 917: enum margverr av;
1.1 kristaps 918: char *p;
919:
1.63 kristaps 920: nl = MDOC_NEWLINE & m->flags;
921:
1.45 kristaps 922: /* Close out prior implicit scope. */
1.19 kristaps 923:
1.1 kristaps 924: if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
1.32 kristaps 925: if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
1.1 kristaps 926: return(0);
1.32 kristaps 927: if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
1.1 kristaps 928: return(0);
929: }
930:
1.45 kristaps 931: /*
932: * This routine accomodates implicitly- and explicitly-scoped
933: * macro openings. Implicit ones first close out prior scope
934: * (seen above). Delay opening the head until necessary to
935: * allow leading punctuation to print. Special consideration
936: * for `It -column', which has phrase-part syntax instead of
937: * regular child nodes.
938: */
939:
1.1 kristaps 940: for (arg = NULL;; ) {
1.45 kristaps 941: la = *pos;
1.56 kristaps 942: av = mdoc_argv(m, line, tok, &arg, pos, buf);
1.1 kristaps 943:
1.56 kristaps 944: if (ARGV_WORD == av) {
1.45 kristaps 945: *pos = la;
1.1 kristaps 946: break;
947: }
948:
1.56 kristaps 949: if (ARGV_EOLN == av)
1.1 kristaps 950: break;
1.56 kristaps 951: if (ARGV_ARG == av)
1.1 kristaps 952: continue;
953:
954: mdoc_argv_free(arg);
955: return(0);
956: }
957:
1.32 kristaps 958: if ( ! mdoc_block_alloc(m, line, ppos, tok, arg))
1.1 kristaps 959: return(0);
960:
1.49 kristaps 961: head = body = NULL;
1.1 kristaps 962:
1.45 kristaps 963: /*
964: * The `Nd' macro has all arguments in its body: it's a hybrid
965: * of block partial-explicit and full-implicit. Stupid.
966: */
1.19 kristaps 967:
1.45 kristaps 968: if (MDOC_Nd == tok) {
969: if ( ! mdoc_head_alloc(m, line, ppos, tok))
970: return(0);
971: head = m->last;
1.32 kristaps 972: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.19 kristaps 973: return(0);
1.32 kristaps 974: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1.19 kristaps 975: return(0);
1.49 kristaps 976: body = m->last;
1.19 kristaps 977: }
978:
1.59 kristaps 979: ac = ARGS_ERROR;
980:
1.62 kristaps 981: for ( ; ; ) {
1.45 kristaps 982: la = *pos;
1.59 kristaps 983: lac = ac;
1.53 kristaps 984: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 985:
1.53 kristaps 986: if (ARGS_ERROR == ac)
1.1 kristaps 987: return(0);
1.53 kristaps 988: if (ARGS_EOLN == ac)
1.1 kristaps 989: break;
1.45 kristaps 990:
1.65 kristaps 991: if (ARGS_PEND == ac) {
992: if (ARGS_PPHRASE == lac)
993: ac = ARGS_PPHRASE;
994: else
995: ac = ARGS_PHRASE;
996: }
997:
1.45 kristaps 998: /* Don't emit leading punct. for phrases. */
999:
1.59 kristaps 1000: if (NULL == head &&
1001: ARGS_PHRASE != ac &&
1.57 kristaps 1002: ARGS_PPHRASE != ac &&
1.53 kristaps 1003: ARGS_QWORD != ac &&
1.67 ! schwarze 1004: DELIM_OPEN == mdoc_isdelim(p)) {
1.45 kristaps 1005: if ( ! mdoc_word_alloc(m, line, la, p))
1006: return(0);
1007: continue;
1008: }
1009:
1010: /* Always re-open head for phrases. */
1011:
1.59 kristaps 1012: if (NULL == head ||
1013: ARGS_PHRASE == ac ||
1.57 kristaps 1014: ARGS_PPHRASE == ac) {
1.45 kristaps 1015: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1016: return(0);
1017: head = m->last;
1018: }
1019:
1.65 kristaps 1020: if (ARGS_PHRASE == ac || ARGS_PPHRASE == ac) {
1021: if (ARGS_PPHRASE == ac)
1022: m->flags |= MDOC_PPHRASE;
1.62 kristaps 1023: if ( ! phrase(m, line, la, buf, ac))
1.1 kristaps 1024: return(0);
1.65 kristaps 1025: m->flags &= ~MDOC_PPHRASE;
1.32 kristaps 1026: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1027: return(0);
1028: continue;
1029: }
1030:
1.54 kristaps 1031: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1032:
1033: if (MDOC_MAX == ntok) {
1.53 kristaps 1034: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1035: return(0);
1.53 kristaps 1036: continue;
1.45 kristaps 1037: }
1.53 kristaps 1038:
1039: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.45 kristaps 1040: return(0);
1.53 kristaps 1041: break;
1.45 kristaps 1042: }
1.1 kristaps 1043:
1.45 kristaps 1044: if (NULL == head) {
1045: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1.1 kristaps 1046: return(0);
1.45 kristaps 1047: head = m->last;
1.1 kristaps 1048: }
1049:
1.63 kristaps 1050: if (nl && ! append_delims(m, line, pos, buf))
1.1 kristaps 1051: return(0);
1.19 kristaps 1052:
1.49 kristaps 1053: /* If we've already opened our body, exit now. */
1.45 kristaps 1054:
1.49 kristaps 1055: if (NULL != body)
1.19 kristaps 1056: return(1);
1057:
1.47 kristaps 1058: #ifdef UGLY
1059: /*
1.49 kristaps 1060: * If there is an open (i.e., unvalidated) sub-block requiring
1061: * explicit close-out, postpone switching the current block from
1062: * head to body until the rew_sub() call closing out that
1063: * sub-block.
1.47 kristaps 1064: */
1065: for (n = m->last; n && n != head; n = n->parent) {
1.49 kristaps 1066: if (MDOC_BLOCK == n->type &&
1067: MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1068: ! (MDOC_VALID & n->flags)) {
1069: assert( ! (MDOC_ACTED & n->flags));
1.47 kristaps 1070: n->pending = head;
1071: return(1);
1072: }
1073: }
1074: #endif
1075:
1.45 kristaps 1076: /* Close out scopes to remain in a consistent state. */
1077:
1.32 kristaps 1078: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1079: return(0);
1.32 kristaps 1080: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1.1 kristaps 1081: return(0);
1082:
1083: return(1);
1084: }
1085:
1086:
1087: static int
1088: blk_part_imp(MACRO_PROT_ARGS)
1089: {
1.63 kristaps 1090: int la, nl;
1.53 kristaps 1091: enum mdoct ntok;
1.55 kristaps 1092: enum margserr ac;
1.1 kristaps 1093: char *p;
1.43 kristaps 1094: struct mdoc_node *blk; /* saved block context */
1095: struct mdoc_node *body; /* saved body context */
1096: struct mdoc_node *n;
1.1 kristaps 1097:
1.63 kristaps 1098: nl = MDOC_NEWLINE & m->flags;
1099:
1.43 kristaps 1100: /*
1101: * A macro that spans to the end of the line. This is generally
1102: * (but not necessarily) called as the first macro. The block
1103: * has a head as the immediate child, which is always empty,
1104: * followed by zero or more opening punctuation nodes, then the
1105: * body (which may be empty, depending on the macro), then zero
1106: * or more closing punctuation nodes.
1107: */
1.32 kristaps 1108:
1109: if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL))
1110: return(0);
1.43 kristaps 1111:
1.32 kristaps 1112: blk = m->last;
1.43 kristaps 1113:
1.32 kristaps 1114: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1.1 kristaps 1115: return(0);
1.32 kristaps 1116: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1117: return(0);
1118:
1.43 kristaps 1119: /*
1120: * Open the body scope "on-demand", that is, after we've
1121: * processed all our the leading delimiters (open parenthesis,
1122: * etc.).
1123: */
1.1 kristaps 1124:
1.43 kristaps 1125: for (body = NULL; ; ) {
1.32 kristaps 1126: la = *pos;
1.53 kristaps 1127: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.43 kristaps 1128:
1.53 kristaps 1129: if (ARGS_ERROR == ac)
1.1 kristaps 1130: return(0);
1.53 kristaps 1131: if (ARGS_EOLN == ac)
1.43 kristaps 1132: break;
1.53 kristaps 1133: if (ARGS_PUNCT == ac)
1.1 kristaps 1134: break;
1135:
1.53 kristaps 1136: if (NULL == body && ARGS_QWORD != ac &&
1.67 ! schwarze 1137: DELIM_OPEN == mdoc_isdelim(p)) {
1.32 kristaps 1138: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1139: return(0);
1140: continue;
1141: }
1142:
1.43 kristaps 1143: if (NULL == body) {
1144: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1145: return(0);
1146: body = m->last;
1147: }
1148:
1.54 kristaps 1149: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1150:
1151: if (MDOC_MAX == ntok) {
1.53 kristaps 1152: if ( ! mdoc_word_alloc(m, line, la, p))
1.43 kristaps 1153: return(0);
1.53 kristaps 1154: continue;
1155: }
1.43 kristaps 1156:
1.53 kristaps 1157: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.1 kristaps 1158: return(0);
1.53 kristaps 1159: break;
1.1 kristaps 1160: }
1161:
1.43 kristaps 1162: /* Clean-ups to leave in a consistent state. */
1163:
1.44 kristaps 1164: if (NULL == body) {
1165: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1166: return(0);
1167: body = m->last;
1.64 kristaps 1168: }
1169:
1170: for (n = body->child; n && n->next; n = n->next)
1171: /* Do nothing. */ ;
1172:
1173: /*
1174: * End of sentence spacing: if the last node is a text node and
1175: * has a trailing period, then mark it as being end-of-sentence.
1176: */
1177:
1178: if (n && MDOC_TEXT == n->type && n->string)
1179: if (mandoc_eos(n->string, strlen(n->string)))
1180: n->flags |= MDOC_EOS;
1181:
1182: /* Up-propogate the end-of-space flag. */
1183:
1184: if (n && (MDOC_EOS & n->flags)) {
1185: body->flags |= MDOC_EOS;
1186: body->parent->flags |= MDOC_EOS;
1.44 kristaps 1187: }
1.43 kristaps 1188:
1.32 kristaps 1189: /*
1190: * If we can't rewind to our body, then our scope has already
1191: * been closed by another macro (like `Oc' closing `Op'). This
1192: * is ugly behaviour nodding its head to OpenBSD's overwhelming
1.47 kristaps 1193: * crufty use of `Op' breakage.
1.63 kristaps 1194: *
1195: * FIXME - this should be ifdef'd OpenBSD?
1.1 kristaps 1196: */
1.32 kristaps 1197: for (n = m->last; n; n = n->parent)
1.1 kristaps 1198: if (body == n)
1199: break;
1.43 kristaps 1200:
1.32 kristaps 1201: if (NULL == n && ! mdoc_nwarn(m, body, EIMPBRK))
1202: return(0);
1.43 kristaps 1203:
1.32 kristaps 1204: if (n && ! rew_last(m, body))
1205: return(0);
1.1 kristaps 1206:
1.32 kristaps 1207: /* Standard appending of delimiters. */
1.1 kristaps 1208:
1.63 kristaps 1209: if (nl && ! append_delims(m, line, pos, buf))
1.1 kristaps 1210: return(0);
1211:
1.32 kristaps 1212: /* Rewind scope, if applicable. */
1.1 kristaps 1213:
1.32 kristaps 1214: if (n && ! rew_last(m, blk))
1.1 kristaps 1215: return(0);
1216:
1217: return(1);
1218: }
1219:
1220:
1221: static int
1222: blk_part_exp(MACRO_PROT_ARGS)
1223: {
1.60 kristaps 1224: int la, nl;
1.55 kristaps 1225: enum margserr ac;
1.43 kristaps 1226: struct mdoc_node *head; /* keep track of head */
1227: struct mdoc_node *body; /* keep track of body */
1.1 kristaps 1228: char *p;
1.53 kristaps 1229: enum mdoct ntok;
1.1 kristaps 1230:
1.60 kristaps 1231: nl = MDOC_NEWLINE & m->flags;
1232:
1.43 kristaps 1233: /*
1234: * The opening of an explicit macro having zero or more leading
1235: * punctuation nodes; a head with optional single element (the
1236: * case of `Eo'); and a body that may be empty.
1237: */
1.32 kristaps 1238:
1239: if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL))
1.1 kristaps 1240: return(0);
1.32 kristaps 1241:
1.43 kristaps 1242: for (head = body = NULL; ; ) {
1.32 kristaps 1243: la = *pos;
1.53 kristaps 1244: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 1245:
1.53 kristaps 1246: if (ARGS_ERROR == ac)
1.1 kristaps 1247: return(0);
1.53 kristaps 1248: if (ARGS_PUNCT == ac)
1.1 kristaps 1249: break;
1.53 kristaps 1250: if (ARGS_EOLN == ac)
1.1 kristaps 1251: break;
1.43 kristaps 1252:
1253: /* Flush out leading punctuation. */
1254:
1.53 kristaps 1255: if (NULL == head && ARGS_QWORD != ac &&
1.67 ! schwarze 1256: DELIM_OPEN == mdoc_isdelim(p)) {
1.43 kristaps 1257: assert(NULL == body);
1258: if ( ! mdoc_word_alloc(m, line, la, p))
1259: return(0);
1260: continue;
1261: }
1262:
1263: if (NULL == head) {
1264: assert(NULL == body);
1265: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1.1 kristaps 1266: return(0);
1.43 kristaps 1267: head = m->last;
1.1 kristaps 1268: }
1269:
1.43 kristaps 1270: /*
1271: * `Eo' gobbles any data into the head, but most other
1272: * macros just immediately close out and begin the body.
1273: */
1274:
1275: if (NULL == body) {
1276: assert(head);
1277: /* No check whether it's a macro! */
1278: if (MDOC_Eo == tok)
1279: if ( ! mdoc_word_alloc(m, line, la, p))
1280: return(0);
1281:
1.32 kristaps 1282: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1283: return(0);
1.32 kristaps 1284: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1.1 kristaps 1285: return(0);
1.43 kristaps 1286: body = m->last;
1287:
1288: if (MDOC_Eo == tok)
1289: continue;
1.1 kristaps 1290: }
1.43 kristaps 1291:
1292: assert(NULL != head && NULL != body);
1293:
1.54 kristaps 1294: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1295:
1296: if (MDOC_MAX == ntok) {
1.53 kristaps 1297: if ( ! mdoc_word_alloc(m, line, la, p))
1.43 kristaps 1298: return(0);
1.53 kristaps 1299: continue;
1.43 kristaps 1300: }
1301:
1.53 kristaps 1302: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.1 kristaps 1303: return(0);
1.53 kristaps 1304: break;
1.1 kristaps 1305: }
1306:
1.43 kristaps 1307: /* Clean-up to leave in a consistent state. */
1.32 kristaps 1308:
1.43 kristaps 1309: if (NULL == head) {
1310: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1311: return(0);
1312: head = m->last;
1313: }
1314:
1315: if (NULL == body) {
1.32 kristaps 1316: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1317: return(0);
1.32 kristaps 1318: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1.1 kristaps 1319: return(0);
1.43 kristaps 1320: body = m->last;
1.1 kristaps 1321: }
1322:
1.32 kristaps 1323: /* Standard appending of delimiters. */
1324:
1.60 kristaps 1325: if ( ! nl)
1.1 kristaps 1326: return(1);
1.32 kristaps 1327: return(append_delims(m, line, pos, buf));
1.1 kristaps 1328: }
1329:
1330:
1.61 kristaps 1331: /* ARGSUSED */
1.1 kristaps 1332: static int
1333: in_line_argn(MACRO_PROT_ARGS)
1334: {
1.60 kristaps 1335: int la, flushed, j, maxargs, nl;
1.55 kristaps 1336: enum margserr ac;
1.56 kristaps 1337: enum margverr av;
1.53 kristaps 1338: struct mdoc_arg *arg;
1339: char *p;
1340: enum mdoct ntok;
1.1 kristaps 1341:
1.60 kristaps 1342: nl = MDOC_NEWLINE & m->flags;
1343:
1.46 kristaps 1344: /*
1345: * A line macro that has a fixed number of arguments (maxargs).
1346: * Only open the scope once the first non-leading-punctuation is
1347: * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1348: * keep it open until the maximum number of arguments are
1349: * exhausted.
1350: */
1.1 kristaps 1351:
1352: switch (tok) {
1353: case (MDOC_Ap):
1354: /* FALLTHROUGH */
1355: case (MDOC_No):
1356: /* FALLTHROUGH */
1357: case (MDOC_Ns):
1358: /* FALLTHROUGH */
1359: case (MDOC_Ux):
1360: maxargs = 0;
1361: break;
1.42 kristaps 1362: case (MDOC_Xr):
1363: maxargs = 2;
1364: break;
1.1 kristaps 1365: default:
1366: maxargs = 1;
1367: break;
1368: }
1369:
1.46 kristaps 1370: for (arg = NULL; ; ) {
1.32 kristaps 1371: la = *pos;
1.56 kristaps 1372: av = mdoc_argv(m, line, tok, &arg, pos, buf);
1.1 kristaps 1373:
1.56 kristaps 1374: if (ARGV_WORD == av) {
1.32 kristaps 1375: *pos = la;
1.1 kristaps 1376: break;
1377: }
1378:
1.56 kristaps 1379: if (ARGV_EOLN == av)
1.1 kristaps 1380: break;
1.56 kristaps 1381: if (ARGV_ARG == av)
1.1 kristaps 1382: continue;
1383:
1384: mdoc_argv_free(arg);
1385: return(0);
1386: }
1387:
1.46 kristaps 1388: for (flushed = j = 0; ; ) {
1.32 kristaps 1389: la = *pos;
1.53 kristaps 1390: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 1391:
1.53 kristaps 1392: if (ARGS_ERROR == ac)
1.1 kristaps 1393: return(0);
1.53 kristaps 1394: if (ARGS_PUNCT == ac)
1.1 kristaps 1395: break;
1.53 kristaps 1396: if (ARGS_EOLN == ac)
1.1 kristaps 1397: break;
1398:
1.46 kristaps 1399: if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1.53 kristaps 1400: ARGS_QWORD != ac &&
1.67 ! schwarze 1401: 0 == j && DELIM_OPEN == mdoc_isdelim(p)) {
1.46 kristaps 1402: if ( ! mdoc_word_alloc(m, line, la, p))
1403: return(0);
1404: continue;
1405: } else if (0 == j)
1406: if ( ! mdoc_elem_alloc(m, line, la, tok, arg))
1407: return(0);
1408:
1409: if (j == maxargs && ! flushed) {
1410: if ( ! rew_elem(m, tok))
1411: return(0);
1412: flushed = 1;
1413: }
1414:
1.54 kristaps 1415: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1416:
1417: if (MDOC_MAX != ntok) {
1.32 kristaps 1418: if ( ! flushed && ! rew_elem(m, tok))
1.1 kristaps 1419: return(0);
1420: flushed = 1;
1.53 kristaps 1421: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.1 kristaps 1422: return(0);
1.46 kristaps 1423: j++;
1.1 kristaps 1424: break;
1425: }
1426:
1427: if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1.53 kristaps 1428: ARGS_QWORD != ac &&
1.67 ! schwarze 1429: ! flushed &&
! 1430: DELIM_NONE != mdoc_isdelim(p)) {
1.32 kristaps 1431: if ( ! rew_elem(m, tok))
1.1 kristaps 1432: return(0);
1433: flushed = 1;
1434: }
1.42 kristaps 1435:
1436: /*
1437: * XXX: this is a hack to work around groff's ugliness
1438: * as regards `Xr' and extraneous arguments. It should
1439: * ideally be deprecated behaviour, but because this is
1440: * code is no here, it's unlikely to be removed.
1441: */
1.43 kristaps 1442:
1.46 kristaps 1443: #ifdef __OpenBSD__
1.42 kristaps 1444: if (MDOC_Xr == tok && j == maxargs) {
1.46 kristaps 1445: if ( ! mdoc_elem_alloc(m, line, la, MDOC_Ns, NULL))
1.42 kristaps 1446: return(0);
1447: if ( ! rew_elem(m, MDOC_Ns))
1448: return(0);
1449: }
1.46 kristaps 1450: #endif
1.42 kristaps 1451:
1.32 kristaps 1452: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1453: return(0);
1.46 kristaps 1454: j++;
1.1 kristaps 1455: }
1456:
1.46 kristaps 1457: if (0 == j && ! mdoc_elem_alloc(m, line, la, tok, arg))
1458: return(0);
1459:
1460: /* Close out in a consistent state. */
1.32 kristaps 1461:
1462: if ( ! flushed && ! rew_elem(m, tok))
1.1 kristaps 1463: return(0);
1.60 kristaps 1464: if ( ! nl)
1.1 kristaps 1465: return(1);
1.32 kristaps 1466: return(append_delims(m, line, pos, buf));
1.1 kristaps 1467: }
1468:
1469:
1470: static int
1471: in_line_eoln(MACRO_PROT_ARGS)
1472: {
1.56 kristaps 1473: int la;
1.55 kristaps 1474: enum margserr ac;
1.56 kristaps 1475: enum margverr av;
1.53 kristaps 1476: struct mdoc_arg *arg;
1477: char *p;
1478: enum mdoct ntok;
1.1 kristaps 1479:
1480: assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
1481:
1.32 kristaps 1482: /* Parse macro arguments. */
1.1 kristaps 1483:
1.32 kristaps 1484: for (arg = NULL; ; ) {
1.1 kristaps 1485: la = *pos;
1.56 kristaps 1486: av = mdoc_argv(m, line, tok, &arg, pos, buf);
1.1 kristaps 1487:
1.56 kristaps 1488: if (ARGV_WORD == av) {
1.1 kristaps 1489: *pos = la;
1490: break;
1491: }
1.56 kristaps 1492: if (ARGV_EOLN == av)
1.1 kristaps 1493: break;
1.56 kristaps 1494: if (ARGV_ARG == av)
1.1 kristaps 1495: continue;
1496:
1497: mdoc_argv_free(arg);
1498: return(0);
1499: }
1500:
1.32 kristaps 1501: /* Open element scope. */
1502:
1503: if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1.1 kristaps 1504: return(0);
1505:
1.32 kristaps 1506: /* Parse argument terms. */
1.1 kristaps 1507:
1508: for (;;) {
1509: la = *pos;
1.53 kristaps 1510: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 1511:
1.53 kristaps 1512: if (ARGS_ERROR == ac)
1.1 kristaps 1513: return(0);
1.53 kristaps 1514: if (ARGS_EOLN == ac)
1.1 kristaps 1515: break;
1516:
1.53 kristaps 1517: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1.1 kristaps 1518:
1.53 kristaps 1519: if (MDOC_MAX == ntok) {
1520: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1521: return(0);
1.53 kristaps 1522: continue;
1523: }
1.1 kristaps 1524:
1.53 kristaps 1525: if ( ! rew_elem(m, tok))
1.1 kristaps 1526: return(0);
1.53 kristaps 1527: return(mdoc_macro(m, ntok, line, la, pos, buf));
1.1 kristaps 1528: }
1529:
1.32 kristaps 1530: /* Close out (no delimiters). */
1531:
1532: return(rew_elem(m, tok));
1.1 kristaps 1533: }
1534:
1535:
1536: /* ARGSUSED */
1537: static int
1.41 kristaps 1538: ctx_synopsis(MACRO_PROT_ARGS)
1539: {
1.60 kristaps 1540: int nl;
1541:
1542: nl = MDOC_NEWLINE & m->flags;
1.41 kristaps 1543:
1544: /* If we're not in the SYNOPSIS, go straight to in-line. */
1545: if (SEC_SYNOPSIS != m->lastsec)
1546: return(in_line(m, tok, line, ppos, pos, buf));
1547:
1548: /* If we're a nested call, same place. */
1.60 kristaps 1549: if ( ! nl)
1.41 kristaps 1550: return(in_line(m, tok, line, ppos, pos, buf));
1551:
1552: /*
1553: * XXX: this will open a block scope; however, if later we end
1554: * up formatting the block scope, then child nodes will inherit
1555: * the formatting. Be careful.
1556: */
1557:
1558: return(blk_part_imp(m, tok, line, ppos, pos, buf));
1559: }
1560:
1561:
1562: /* ARGSUSED */
1563: static int
1.1 kristaps 1564: obsolete(MACRO_PROT_ARGS)
1565: {
1566:
1.32 kristaps 1567: return(mdoc_pwarn(m, line, ppos, EOBS));
1.1 kristaps 1568: }
1569:
1570:
1.24 kristaps 1571: /*
1572: * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1573: * They're unusual because they're basically free-form text until a
1574: * macro is encountered.
1575: */
1.1 kristaps 1576: static int
1.62 kristaps 1577: phrase(struct mdoc *m, int line, int ppos, char *buf, enum margserr ac)
1.1 kristaps 1578: {
1.53 kristaps 1579: int la, pos;
1.59 kristaps 1580: enum margserr aac;
1.53 kristaps 1581: enum mdoct ntok;
1582: char *p;
1.1 kristaps 1583:
1.65 kristaps 1584: assert(ARGS_PHRASE == ac || ARGS_PPHRASE == ac);
1.59 kristaps 1585:
1.24 kristaps 1586: for (pos = ppos; ; ) {
1587: la = pos;
1.1 kristaps 1588:
1.65 kristaps 1589: aac = mdoc_zargs(m, line, &pos, buf, 0, &p);
1.1 kristaps 1590:
1.59 kristaps 1591: if (ARGS_ERROR == aac)
1.24 kristaps 1592: return(0);
1.59 kristaps 1593: if (ARGS_EOLN == aac)
1.24 kristaps 1594: break;
1.1 kristaps 1595:
1.65 kristaps 1596: ntok = ARGS_QWORD == aac ? MDOC_MAX : lookup_raw(p);
1.1 kristaps 1597:
1.53 kristaps 1598: if (MDOC_MAX == ntok) {
1599: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1600: return(0);
1.53 kristaps 1601: continue;
1602: }
1.1 kristaps 1603:
1.53 kristaps 1604: if ( ! mdoc_macro(m, ntok, line, la, &pos, buf))
1.1 kristaps 1605: return(0);
1.53 kristaps 1606: return(append_delims(m, line, &pos, buf));
1.1 kristaps 1607: }
1608:
1609: return(1);
1610: }
1.24 kristaps 1611:
1612:
CVSweb