Annotation of mandoc/mdoc_macro.c, Revision 1.66
1.66 ! kristaps 1: /* $Id: mdoc_macro.c,v 1.65 2010/05/15 04:47:38 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.1 kristaps 643: assert(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.60 kristaps 753: int la, lastpunct, cnt, d, nc, nl;
1.56 kristaps 754: enum margverr av;
1.53 kristaps 755: enum mdoct ntok;
1.55 kristaps 756: enum margserr ac;
1.53 kristaps 757: struct mdoc_arg *arg;
758: char *p;
1.1 kristaps 759:
1.60 kristaps 760: nl = MDOC_NEWLINE & m->flags;
761:
1.4 kristaps 762: /*
763: * Whether we allow ignored elements (those without content,
764: * usually because of reserved words) to squeak by.
765: */
1.45 kristaps 766:
1.4 kristaps 767: switch (tok) {
1.26 kristaps 768: case (MDOC_An):
769: /* FALLTHROUGH */
770: case (MDOC_Ar):
1.4 kristaps 771: /* FALLTHROUGH */
772: case (MDOC_Fl):
773: /* FALLTHROUGH */
1.12 kristaps 774: case (MDOC_Lk):
775: /* FALLTHROUGH */
1.26 kristaps 776: case (MDOC_Nm):
777: /* FALLTHROUGH */
1.25 kristaps 778: case (MDOC_Pa):
1.4 kristaps 779: nc = 1;
780: break;
781: default:
782: nc = 0;
783: break;
784: }
785:
1.27 kristaps 786: for (arg = NULL;; ) {
1.1 kristaps 787: la = *pos;
1.56 kristaps 788: av = mdoc_argv(m, line, tok, &arg, pos, buf);
1.1 kristaps 789:
1.56 kristaps 790: if (ARGV_WORD == av) {
1.1 kristaps 791: *pos = la;
792: break;
793: }
1.56 kristaps 794: if (ARGV_EOLN == av)
1.1 kristaps 795: break;
1.56 kristaps 796: if (ARGV_ARG == av)
1.1 kristaps 797: continue;
798:
799: mdoc_argv_free(arg);
800: return(0);
801: }
802:
1.4 kristaps 803: for (cnt = 0, lastpunct = 1;; ) {
1.1 kristaps 804: la = *pos;
1.53 kristaps 805: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 806:
1.53 kristaps 807: if (ARGS_ERROR == ac)
1.1 kristaps 808: return(0);
1.53 kristaps 809: if (ARGS_EOLN == ac)
1.1 kristaps 810: break;
1.53 kristaps 811: if (ARGS_PUNCT == ac)
1.1 kristaps 812: break;
813:
1.53 kristaps 814: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1.1 kristaps 815:
1.4 kristaps 816: /*
817: * In this case, we've located a submacro and must
818: * execute it. Close out scope, if open. If no
819: * elements have been generated, either create one (nc)
820: * or raise a warning.
821: */
1.1 kristaps 822:
1.53 kristaps 823: if (MDOC_MAX != ntok) {
1.32 kristaps 824: if (0 == lastpunct && ! rew_elem(m, tok))
1.1 kristaps 825: return(0);
1.4 kristaps 826: if (nc && 0 == cnt) {
1.32 kristaps 827: if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1.3 kristaps 828: return(0);
1.32 kristaps 829: if ( ! rew_last(m, m->last))
1.12 kristaps 830: return(0);
1.7 kristaps 831: } else if ( ! nc && 0 == cnt) {
832: mdoc_argv_free(arg);
1.32 kristaps 833: if ( ! mdoc_pwarn(m, line, ppos, EIGNE))
1.3 kristaps 834: return(0);
1.7 kristaps 835: }
1.53 kristaps 836: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.1 kristaps 837: return(0);
1.60 kristaps 838: if ( ! nl)
1.1 kristaps 839: return(1);
1.32 kristaps 840: return(append_delims(m, line, pos, buf));
1.29 kristaps 841: }
1.1 kristaps 842:
1.4 kristaps 843: /*
844: * Non-quote-enclosed punctuation. Set up our scope, if
845: * a word; rewind the scope, if a delimiter; then append
846: * the word.
847: */
1.1 kristaps 848:
1.53 kristaps 849: d = ARGS_QWORD == ac ? 0 : mdoc_isdelim(p);
1.3 kristaps 850:
1.53 kristaps 851: if (ARGS_QWORD != ac && d) {
1.32 kristaps 852: if (0 == lastpunct && ! rew_elem(m, tok))
1.1 kristaps 853: return(0);
854: lastpunct = 1;
855: } else if (lastpunct) {
1.32 kristaps 856: if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1.1 kristaps 857: return(0);
858: lastpunct = 0;
859: }
860:
1.3 kristaps 861: if ( ! d)
862: cnt++;
1.32 kristaps 863: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 864: return(0);
1.39 kristaps 865:
866: /*
867: * `Fl' macros have their scope re-opened with each new
868: * word so that the `-' can be added to each one without
869: * having to parse out spaces.
870: */
871: if (0 == lastpunct && MDOC_Fl == tok) {
872: if ( ! rew_elem(m, tok))
873: return(0);
874: lastpunct = 1;
875: }
1.1 kristaps 876: }
877:
1.32 kristaps 878: if (0 == lastpunct && ! rew_elem(m, tok))
1.1 kristaps 879: return(0);
1.4 kristaps 880:
881: /*
882: * If no elements have been collected and we're allowed to have
883: * empties (nc), open a scope and close it out. Otherwise,
884: * raise a warning.
885: */
1.45 kristaps 886:
1.4 kristaps 887: if (nc && 0 == cnt) {
1.32 kristaps 888: if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1.3 kristaps 889: return(0);
1.32 kristaps 890: if ( ! rew_last(m, m->last))
1.12 kristaps 891: return(0);
1.7 kristaps 892: } else if ( ! nc && 0 == cnt) {
893: mdoc_argv_free(arg);
1.32 kristaps 894: if ( ! mdoc_pwarn(m, line, ppos, EIGNE))
1.3 kristaps 895: return(0);
1.7 kristaps 896: }
1.4 kristaps 897:
1.60 kristaps 898: if ( ! nl)
1.1 kristaps 899: return(1);
1.32 kristaps 900: return(append_delims(m, line, pos, buf));
1.1 kristaps 901: }
902:
903:
904: static int
905: blk_full(MACRO_PROT_ARGS)
906: {
1.63 kristaps 907: int la, nl;
1.1 kristaps 908: struct mdoc_arg *arg;
1.45 kristaps 909: struct mdoc_node *head; /* save of head macro */
1.49 kristaps 910: struct mdoc_node *body; /* save of body macro */
1.48 kristaps 911: #ifdef UGLY
1.47 kristaps 912: struct mdoc_node *n;
1.48 kristaps 913: #endif
1.53 kristaps 914: enum mdoct ntok;
1.59 kristaps 915: enum margserr ac, lac;
1.56 kristaps 916: enum margverr av;
1.1 kristaps 917: char *p;
918:
1.63 kristaps 919: nl = MDOC_NEWLINE & m->flags;
920:
1.45 kristaps 921: /* Close out prior implicit scope. */
1.19 kristaps 922:
1.1 kristaps 923: if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
1.32 kristaps 924: if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
1.1 kristaps 925: return(0);
1.32 kristaps 926: if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
1.1 kristaps 927: return(0);
928: }
929:
1.45 kristaps 930: /*
931: * This routine accomodates implicitly- and explicitly-scoped
932: * macro openings. Implicit ones first close out prior scope
933: * (seen above). Delay opening the head until necessary to
934: * allow leading punctuation to print. Special consideration
935: * for `It -column', which has phrase-part syntax instead of
936: * regular child nodes.
937: */
938:
1.1 kristaps 939: for (arg = NULL;; ) {
1.45 kristaps 940: la = *pos;
1.56 kristaps 941: av = mdoc_argv(m, line, tok, &arg, pos, buf);
1.1 kristaps 942:
1.56 kristaps 943: if (ARGV_WORD == av) {
1.45 kristaps 944: *pos = la;
1.1 kristaps 945: break;
946: }
947:
1.56 kristaps 948: if (ARGV_EOLN == av)
1.1 kristaps 949: break;
1.56 kristaps 950: if (ARGV_ARG == av)
1.1 kristaps 951: continue;
952:
953: mdoc_argv_free(arg);
954: return(0);
955: }
956:
1.32 kristaps 957: if ( ! mdoc_block_alloc(m, line, ppos, tok, arg))
1.1 kristaps 958: return(0);
959:
1.49 kristaps 960: head = body = NULL;
1.1 kristaps 961:
1.45 kristaps 962: /*
963: * The `Nd' macro has all arguments in its body: it's a hybrid
964: * of block partial-explicit and full-implicit. Stupid.
965: */
1.19 kristaps 966:
1.45 kristaps 967: if (MDOC_Nd == tok) {
968: if ( ! mdoc_head_alloc(m, line, ppos, tok))
969: return(0);
970: head = m->last;
1.32 kristaps 971: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.19 kristaps 972: return(0);
1.32 kristaps 973: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1.19 kristaps 974: return(0);
1.49 kristaps 975: body = m->last;
1.19 kristaps 976: }
977:
1.59 kristaps 978: ac = ARGS_ERROR;
979:
1.62 kristaps 980: for ( ; ; ) {
1.45 kristaps 981: la = *pos;
1.59 kristaps 982: lac = ac;
1.53 kristaps 983: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 984:
1.53 kristaps 985: if (ARGS_ERROR == ac)
1.1 kristaps 986: return(0);
1.53 kristaps 987: if (ARGS_EOLN == ac)
1.1 kristaps 988: break;
1.45 kristaps 989:
1.65 kristaps 990: if (ARGS_PEND == ac) {
991: if (ARGS_PPHRASE == lac)
992: ac = ARGS_PPHRASE;
993: else
994: ac = ARGS_PHRASE;
995: }
996:
1.45 kristaps 997: /* Don't emit leading punct. for phrases. */
998:
1.59 kristaps 999: if (NULL == head &&
1000: ARGS_PHRASE != ac &&
1.57 kristaps 1001: ARGS_PPHRASE != ac &&
1.53 kristaps 1002: ARGS_QWORD != ac &&
1.45 kristaps 1003: 1 == mdoc_isdelim(p)) {
1004: if ( ! mdoc_word_alloc(m, line, la, p))
1005: return(0);
1006: continue;
1007: }
1008:
1009: /* Always re-open head for phrases. */
1010:
1.59 kristaps 1011: if (NULL == head ||
1012: ARGS_PHRASE == ac ||
1.57 kristaps 1013: ARGS_PPHRASE == ac) {
1.45 kristaps 1014: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1015: return(0);
1016: head = m->last;
1017: }
1018:
1.65 kristaps 1019: if (ARGS_PHRASE == ac || ARGS_PPHRASE == ac) {
1020: if (ARGS_PPHRASE == ac)
1021: m->flags |= MDOC_PPHRASE;
1.62 kristaps 1022: if ( ! phrase(m, line, la, buf, ac))
1.1 kristaps 1023: return(0);
1.65 kristaps 1024: m->flags &= ~MDOC_PPHRASE;
1.32 kristaps 1025: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1026: return(0);
1027: continue;
1028: }
1029:
1.54 kristaps 1030: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1031:
1032: if (MDOC_MAX == ntok) {
1.53 kristaps 1033: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1034: return(0);
1.53 kristaps 1035: continue;
1.45 kristaps 1036: }
1.53 kristaps 1037:
1038: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.45 kristaps 1039: return(0);
1.53 kristaps 1040: break;
1.45 kristaps 1041: }
1.1 kristaps 1042:
1.45 kristaps 1043: if (NULL == head) {
1044: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1.1 kristaps 1045: return(0);
1.45 kristaps 1046: head = m->last;
1.1 kristaps 1047: }
1048:
1.63 kristaps 1049: if (nl && ! append_delims(m, line, pos, buf))
1.1 kristaps 1050: return(0);
1.19 kristaps 1051:
1.49 kristaps 1052: /* If we've already opened our body, exit now. */
1.45 kristaps 1053:
1.49 kristaps 1054: if (NULL != body)
1.19 kristaps 1055: return(1);
1056:
1.47 kristaps 1057: #ifdef UGLY
1058: /*
1.49 kristaps 1059: * If there is an open (i.e., unvalidated) sub-block requiring
1060: * explicit close-out, postpone switching the current block from
1061: * head to body until the rew_sub() call closing out that
1062: * sub-block.
1.47 kristaps 1063: */
1064: for (n = m->last; n && n != head; n = n->parent) {
1.49 kristaps 1065: if (MDOC_BLOCK == n->type &&
1066: MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
1067: ! (MDOC_VALID & n->flags)) {
1068: assert( ! (MDOC_ACTED & n->flags));
1.47 kristaps 1069: n->pending = head;
1070: return(1);
1071: }
1072: }
1073: #endif
1074:
1.45 kristaps 1075: /* Close out scopes to remain in a consistent state. */
1076:
1.32 kristaps 1077: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1078: return(0);
1.32 kristaps 1079: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1.1 kristaps 1080: return(0);
1081:
1082: return(1);
1083: }
1084:
1085:
1086: static int
1087: blk_part_imp(MACRO_PROT_ARGS)
1088: {
1.63 kristaps 1089: int la, nl;
1.53 kristaps 1090: enum mdoct ntok;
1.55 kristaps 1091: enum margserr ac;
1.1 kristaps 1092: char *p;
1.43 kristaps 1093: struct mdoc_node *blk; /* saved block context */
1094: struct mdoc_node *body; /* saved body context */
1095: struct mdoc_node *n;
1.1 kristaps 1096:
1.63 kristaps 1097: nl = MDOC_NEWLINE & m->flags;
1098:
1.43 kristaps 1099: /*
1100: * A macro that spans to the end of the line. This is generally
1101: * (but not necessarily) called as the first macro. The block
1102: * has a head as the immediate child, which is always empty,
1103: * followed by zero or more opening punctuation nodes, then the
1104: * body (which may be empty, depending on the macro), then zero
1105: * or more closing punctuation nodes.
1106: */
1.32 kristaps 1107:
1108: if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL))
1109: return(0);
1.43 kristaps 1110:
1.32 kristaps 1111: blk = m->last;
1.43 kristaps 1112:
1.32 kristaps 1113: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1.1 kristaps 1114: return(0);
1.32 kristaps 1115: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1116: return(0);
1117:
1.43 kristaps 1118: /*
1119: * Open the body scope "on-demand", that is, after we've
1120: * processed all our the leading delimiters (open parenthesis,
1121: * etc.).
1122: */
1.1 kristaps 1123:
1.43 kristaps 1124: for (body = NULL; ; ) {
1.32 kristaps 1125: la = *pos;
1.53 kristaps 1126: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.43 kristaps 1127:
1.53 kristaps 1128: if (ARGS_ERROR == ac)
1.1 kristaps 1129: return(0);
1.53 kristaps 1130: if (ARGS_EOLN == ac)
1.43 kristaps 1131: break;
1.53 kristaps 1132: if (ARGS_PUNCT == ac)
1.1 kristaps 1133: break;
1134:
1.53 kristaps 1135: if (NULL == body && ARGS_QWORD != ac &&
1.50 kristaps 1136: 1 == mdoc_isdelim(p)) {
1.32 kristaps 1137: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1138: return(0);
1139: continue;
1140: }
1141:
1.43 kristaps 1142: if (NULL == body) {
1143: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1144: return(0);
1145: body = m->last;
1146: }
1147:
1.54 kristaps 1148: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1149:
1150: if (MDOC_MAX == ntok) {
1.53 kristaps 1151: if ( ! mdoc_word_alloc(m, line, la, p))
1.43 kristaps 1152: return(0);
1.53 kristaps 1153: continue;
1154: }
1.43 kristaps 1155:
1.53 kristaps 1156: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.1 kristaps 1157: return(0);
1.53 kristaps 1158: break;
1.1 kristaps 1159: }
1160:
1.43 kristaps 1161: /* Clean-ups to leave in a consistent state. */
1162:
1.44 kristaps 1163: if (NULL == body) {
1164: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1165: return(0);
1166: body = m->last;
1.64 kristaps 1167: }
1168:
1169: for (n = body->child; n && n->next; n = n->next)
1170: /* Do nothing. */ ;
1171:
1172: /*
1173: * End of sentence spacing: if the last node is a text node and
1174: * has a trailing period, then mark it as being end-of-sentence.
1175: */
1176:
1177: if (n && MDOC_TEXT == n->type && n->string)
1178: if (mandoc_eos(n->string, strlen(n->string)))
1179: n->flags |= MDOC_EOS;
1180:
1181: /* Up-propogate the end-of-space flag. */
1182:
1183: if (n && (MDOC_EOS & n->flags)) {
1184: body->flags |= MDOC_EOS;
1185: body->parent->flags |= MDOC_EOS;
1.44 kristaps 1186: }
1.43 kristaps 1187:
1.32 kristaps 1188: /*
1189: * If we can't rewind to our body, then our scope has already
1190: * been closed by another macro (like `Oc' closing `Op'). This
1191: * is ugly behaviour nodding its head to OpenBSD's overwhelming
1.47 kristaps 1192: * crufty use of `Op' breakage.
1.63 kristaps 1193: *
1194: * FIXME - this should be ifdef'd OpenBSD?
1.1 kristaps 1195: */
1.32 kristaps 1196: for (n = m->last; n; n = n->parent)
1.1 kristaps 1197: if (body == n)
1198: break;
1.43 kristaps 1199:
1.32 kristaps 1200: if (NULL == n && ! mdoc_nwarn(m, body, EIMPBRK))
1201: return(0);
1.43 kristaps 1202:
1.32 kristaps 1203: if (n && ! rew_last(m, body))
1204: return(0);
1.1 kristaps 1205:
1.32 kristaps 1206: /* Standard appending of delimiters. */
1.1 kristaps 1207:
1.63 kristaps 1208: if (nl && ! append_delims(m, line, pos, buf))
1.1 kristaps 1209: return(0);
1210:
1.32 kristaps 1211: /* Rewind scope, if applicable. */
1.1 kristaps 1212:
1.32 kristaps 1213: if (n && ! rew_last(m, blk))
1.1 kristaps 1214: return(0);
1215:
1216: return(1);
1217: }
1218:
1219:
1220: static int
1221: blk_part_exp(MACRO_PROT_ARGS)
1222: {
1.60 kristaps 1223: int la, nl;
1.55 kristaps 1224: enum margserr ac;
1.43 kristaps 1225: struct mdoc_node *head; /* keep track of head */
1226: struct mdoc_node *body; /* keep track of body */
1.1 kristaps 1227: char *p;
1.53 kristaps 1228: enum mdoct ntok;
1.1 kristaps 1229:
1.60 kristaps 1230: nl = MDOC_NEWLINE & m->flags;
1231:
1.43 kristaps 1232: /*
1233: * The opening of an explicit macro having zero or more leading
1234: * punctuation nodes; a head with optional single element (the
1235: * case of `Eo'); and a body that may be empty.
1236: */
1.32 kristaps 1237:
1238: if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL))
1.1 kristaps 1239: return(0);
1.32 kristaps 1240:
1.43 kristaps 1241: for (head = body = NULL; ; ) {
1.32 kristaps 1242: la = *pos;
1.53 kristaps 1243: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 1244:
1.53 kristaps 1245: if (ARGS_ERROR == ac)
1.1 kristaps 1246: return(0);
1.53 kristaps 1247: if (ARGS_PUNCT == ac)
1.1 kristaps 1248: break;
1.53 kristaps 1249: if (ARGS_EOLN == ac)
1.1 kristaps 1250: break;
1.43 kristaps 1251:
1252: /* Flush out leading punctuation. */
1253:
1.53 kristaps 1254: if (NULL == head && ARGS_QWORD != ac &&
1.50 kristaps 1255: 1 == mdoc_isdelim(p)) {
1.43 kristaps 1256: assert(NULL == body);
1257: if ( ! mdoc_word_alloc(m, line, la, p))
1258: return(0);
1259: continue;
1260: }
1261:
1262: if (NULL == head) {
1263: assert(NULL == body);
1264: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1.1 kristaps 1265: return(0);
1.43 kristaps 1266: head = m->last;
1.1 kristaps 1267: }
1268:
1.43 kristaps 1269: /*
1270: * `Eo' gobbles any data into the head, but most other
1271: * macros just immediately close out and begin the body.
1272: */
1273:
1274: if (NULL == body) {
1275: assert(head);
1276: /* No check whether it's a macro! */
1277: if (MDOC_Eo == tok)
1278: if ( ! mdoc_word_alloc(m, line, la, p))
1279: return(0);
1280:
1.32 kristaps 1281: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1282: return(0);
1.32 kristaps 1283: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1.1 kristaps 1284: return(0);
1.43 kristaps 1285: body = m->last;
1286:
1287: if (MDOC_Eo == tok)
1288: continue;
1.1 kristaps 1289: }
1.43 kristaps 1290:
1291: assert(NULL != head && NULL != body);
1292:
1.54 kristaps 1293: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1294:
1295: if (MDOC_MAX == ntok) {
1.53 kristaps 1296: if ( ! mdoc_word_alloc(m, line, la, p))
1.43 kristaps 1297: return(0);
1.53 kristaps 1298: continue;
1.43 kristaps 1299: }
1300:
1.53 kristaps 1301: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.1 kristaps 1302: return(0);
1.53 kristaps 1303: break;
1.1 kristaps 1304: }
1305:
1.43 kristaps 1306: /* Clean-up to leave in a consistent state. */
1.32 kristaps 1307:
1.43 kristaps 1308: if (NULL == head) {
1309: if ( ! mdoc_head_alloc(m, line, ppos, tok))
1310: return(0);
1311: head = m->last;
1312: }
1313:
1314: if (NULL == body) {
1.32 kristaps 1315: if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1.1 kristaps 1316: return(0);
1.32 kristaps 1317: if ( ! mdoc_body_alloc(m, line, ppos, tok))
1.1 kristaps 1318: return(0);
1.43 kristaps 1319: body = m->last;
1.1 kristaps 1320: }
1321:
1.32 kristaps 1322: /* Standard appending of delimiters. */
1323:
1.60 kristaps 1324: if ( ! nl)
1.1 kristaps 1325: return(1);
1.32 kristaps 1326: return(append_delims(m, line, pos, buf));
1.1 kristaps 1327: }
1328:
1329:
1.61 kristaps 1330: /* ARGSUSED */
1.1 kristaps 1331: static int
1332: in_line_argn(MACRO_PROT_ARGS)
1333: {
1.60 kristaps 1334: int la, flushed, j, maxargs, nl;
1.55 kristaps 1335: enum margserr ac;
1.56 kristaps 1336: enum margverr av;
1.53 kristaps 1337: struct mdoc_arg *arg;
1338: char *p;
1339: enum mdoct ntok;
1.1 kristaps 1340:
1.60 kristaps 1341: nl = MDOC_NEWLINE & m->flags;
1342:
1.46 kristaps 1343: /*
1344: * A line macro that has a fixed number of arguments (maxargs).
1345: * Only open the scope once the first non-leading-punctuation is
1346: * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1347: * keep it open until the maximum number of arguments are
1348: * exhausted.
1349: */
1.1 kristaps 1350:
1351: switch (tok) {
1352: case (MDOC_Ap):
1353: /* FALLTHROUGH */
1354: case (MDOC_No):
1355: /* FALLTHROUGH */
1356: case (MDOC_Ns):
1357: /* FALLTHROUGH */
1358: case (MDOC_Ux):
1359: maxargs = 0;
1360: break;
1.42 kristaps 1361: case (MDOC_Xr):
1362: maxargs = 2;
1363: break;
1.1 kristaps 1364: default:
1365: maxargs = 1;
1366: break;
1367: }
1368:
1.46 kristaps 1369: for (arg = NULL; ; ) {
1.32 kristaps 1370: la = *pos;
1.56 kristaps 1371: av = mdoc_argv(m, line, tok, &arg, pos, buf);
1.1 kristaps 1372:
1.56 kristaps 1373: if (ARGV_WORD == av) {
1.32 kristaps 1374: *pos = la;
1.1 kristaps 1375: break;
1376: }
1377:
1.56 kristaps 1378: if (ARGV_EOLN == av)
1.1 kristaps 1379: break;
1.56 kristaps 1380: if (ARGV_ARG == av)
1.1 kristaps 1381: continue;
1382:
1383: mdoc_argv_free(arg);
1384: return(0);
1385: }
1386:
1.46 kristaps 1387: for (flushed = j = 0; ; ) {
1.32 kristaps 1388: la = *pos;
1.53 kristaps 1389: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 1390:
1.53 kristaps 1391: if (ARGS_ERROR == ac)
1.1 kristaps 1392: return(0);
1.53 kristaps 1393: if (ARGS_PUNCT == ac)
1.1 kristaps 1394: break;
1.53 kristaps 1395: if (ARGS_EOLN == ac)
1.1 kristaps 1396: break;
1397:
1.46 kristaps 1398: if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1.53 kristaps 1399: ARGS_QWORD != ac &&
1.46 kristaps 1400: 0 == j && 1 == mdoc_isdelim(p)) {
1401: if ( ! mdoc_word_alloc(m, line, la, p))
1402: return(0);
1403: continue;
1404: } else if (0 == j)
1405: if ( ! mdoc_elem_alloc(m, line, la, tok, arg))
1406: return(0);
1407:
1408: if (j == maxargs && ! flushed) {
1409: if ( ! rew_elem(m, tok))
1410: return(0);
1411: flushed = 1;
1412: }
1413:
1.54 kristaps 1414: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1415:
1416: if (MDOC_MAX != ntok) {
1.32 kristaps 1417: if ( ! flushed && ! rew_elem(m, tok))
1.1 kristaps 1418: return(0);
1419: flushed = 1;
1.53 kristaps 1420: if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
1.1 kristaps 1421: return(0);
1.46 kristaps 1422: j++;
1.1 kristaps 1423: break;
1424: }
1425:
1426: if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1.53 kristaps 1427: ARGS_QWORD != ac &&
1.1 kristaps 1428: ! flushed && mdoc_isdelim(p)) {
1.32 kristaps 1429: if ( ! rew_elem(m, tok))
1.1 kristaps 1430: return(0);
1431: flushed = 1;
1432: }
1.42 kristaps 1433:
1434: /*
1435: * XXX: this is a hack to work around groff's ugliness
1436: * as regards `Xr' and extraneous arguments. It should
1437: * ideally be deprecated behaviour, but because this is
1438: * code is no here, it's unlikely to be removed.
1439: */
1.43 kristaps 1440:
1.46 kristaps 1441: #ifdef __OpenBSD__
1.42 kristaps 1442: if (MDOC_Xr == tok && j == maxargs) {
1.46 kristaps 1443: if ( ! mdoc_elem_alloc(m, line, la, MDOC_Ns, NULL))
1.42 kristaps 1444: return(0);
1445: if ( ! rew_elem(m, MDOC_Ns))
1446: return(0);
1447: }
1.46 kristaps 1448: #endif
1.42 kristaps 1449:
1.32 kristaps 1450: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1451: return(0);
1.46 kristaps 1452: j++;
1.1 kristaps 1453: }
1454:
1.46 kristaps 1455: if (0 == j && ! mdoc_elem_alloc(m, line, la, tok, arg))
1456: return(0);
1457:
1458: /* Close out in a consistent state. */
1.32 kristaps 1459:
1460: if ( ! flushed && ! rew_elem(m, tok))
1.1 kristaps 1461: return(0);
1.60 kristaps 1462: if ( ! nl)
1.1 kristaps 1463: return(1);
1.32 kristaps 1464: return(append_delims(m, line, pos, buf));
1.1 kristaps 1465: }
1466:
1467:
1468: static int
1469: in_line_eoln(MACRO_PROT_ARGS)
1470: {
1.56 kristaps 1471: int la;
1.55 kristaps 1472: enum margserr ac;
1.56 kristaps 1473: enum margverr av;
1.53 kristaps 1474: struct mdoc_arg *arg;
1475: char *p;
1476: enum mdoct ntok;
1.1 kristaps 1477:
1478: assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
1479:
1.32 kristaps 1480: /* Parse macro arguments. */
1.1 kristaps 1481:
1.32 kristaps 1482: for (arg = NULL; ; ) {
1.1 kristaps 1483: la = *pos;
1.56 kristaps 1484: av = mdoc_argv(m, line, tok, &arg, pos, buf);
1.1 kristaps 1485:
1.56 kristaps 1486: if (ARGV_WORD == av) {
1.1 kristaps 1487: *pos = la;
1488: break;
1489: }
1.56 kristaps 1490: if (ARGV_EOLN == av)
1.1 kristaps 1491: break;
1.56 kristaps 1492: if (ARGV_ARG == av)
1.1 kristaps 1493: continue;
1494:
1495: mdoc_argv_free(arg);
1496: return(0);
1497: }
1498:
1.32 kristaps 1499: /* Open element scope. */
1500:
1501: if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1.1 kristaps 1502: return(0);
1503:
1.32 kristaps 1504: /* Parse argument terms. */
1.1 kristaps 1505:
1506: for (;;) {
1507: la = *pos;
1.53 kristaps 1508: ac = mdoc_args(m, line, pos, buf, tok, &p);
1.1 kristaps 1509:
1.53 kristaps 1510: if (ARGS_ERROR == ac)
1.1 kristaps 1511: return(0);
1.53 kristaps 1512: if (ARGS_EOLN == ac)
1.1 kristaps 1513: break;
1514:
1.53 kristaps 1515: ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
1.1 kristaps 1516:
1.53 kristaps 1517: if (MDOC_MAX == ntok) {
1518: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1519: return(0);
1.53 kristaps 1520: continue;
1521: }
1.1 kristaps 1522:
1.53 kristaps 1523: if ( ! rew_elem(m, tok))
1.1 kristaps 1524: return(0);
1.53 kristaps 1525: return(mdoc_macro(m, ntok, line, la, pos, buf));
1.1 kristaps 1526: }
1527:
1.32 kristaps 1528: /* Close out (no delimiters). */
1529:
1530: return(rew_elem(m, tok));
1.1 kristaps 1531: }
1532:
1533:
1534: /* ARGSUSED */
1535: static int
1.41 kristaps 1536: ctx_synopsis(MACRO_PROT_ARGS)
1537: {
1.60 kristaps 1538: int nl;
1539:
1540: nl = MDOC_NEWLINE & m->flags;
1.41 kristaps 1541:
1542: /* If we're not in the SYNOPSIS, go straight to in-line. */
1543: if (SEC_SYNOPSIS != m->lastsec)
1544: return(in_line(m, tok, line, ppos, pos, buf));
1545:
1546: /* If we're a nested call, same place. */
1.60 kristaps 1547: if ( ! nl)
1.41 kristaps 1548: return(in_line(m, tok, line, ppos, pos, buf));
1549:
1550: /*
1551: * XXX: this will open a block scope; however, if later we end
1552: * up formatting the block scope, then child nodes will inherit
1553: * the formatting. Be careful.
1554: */
1555:
1556: return(blk_part_imp(m, tok, line, ppos, pos, buf));
1557: }
1558:
1559:
1560: /* ARGSUSED */
1561: static int
1.1 kristaps 1562: obsolete(MACRO_PROT_ARGS)
1563: {
1564:
1.32 kristaps 1565: return(mdoc_pwarn(m, line, ppos, EOBS));
1.1 kristaps 1566: }
1567:
1568:
1.24 kristaps 1569: /*
1570: * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1571: * They're unusual because they're basically free-form text until a
1572: * macro is encountered.
1573: */
1.1 kristaps 1574: static int
1.62 kristaps 1575: phrase(struct mdoc *m, int line, int ppos, char *buf, enum margserr ac)
1.1 kristaps 1576: {
1.53 kristaps 1577: int la, pos;
1.59 kristaps 1578: enum margserr aac;
1.53 kristaps 1579: enum mdoct ntok;
1580: char *p;
1.1 kristaps 1581:
1.65 kristaps 1582: assert(ARGS_PHRASE == ac || ARGS_PPHRASE == ac);
1.59 kristaps 1583:
1.24 kristaps 1584: for (pos = ppos; ; ) {
1585: la = pos;
1.1 kristaps 1586:
1.65 kristaps 1587: aac = mdoc_zargs(m, line, &pos, buf, 0, &p);
1.1 kristaps 1588:
1.59 kristaps 1589: if (ARGS_ERROR == aac)
1.24 kristaps 1590: return(0);
1.59 kristaps 1591: if (ARGS_EOLN == aac)
1.24 kristaps 1592: break;
1.1 kristaps 1593:
1.65 kristaps 1594: ntok = ARGS_QWORD == aac ? MDOC_MAX : lookup_raw(p);
1.1 kristaps 1595:
1.53 kristaps 1596: if (MDOC_MAX == ntok) {
1597: if ( ! mdoc_word_alloc(m, line, la, p))
1.1 kristaps 1598: return(0);
1.53 kristaps 1599: continue;
1600: }
1.1 kristaps 1601:
1.53 kristaps 1602: if ( ! mdoc_macro(m, ntok, line, la, &pos, buf))
1.1 kristaps 1603: return(0);
1.53 kristaps 1604: return(append_delims(m, line, &pos, buf));
1.1 kristaps 1605: }
1606:
1607: return(1);
1608: }
1.24 kristaps 1609:
1610:
CVSweb