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