Annotation of mandoc/man_macro.c, Revision 1.60
1.60 ! kristaps 1: /* $Id: man_macro.c,v 1.59 2011/03/23 12:40:04 kristaps Exp $ */
1.1 kristaps 2: /*
1.50 schwarze 3: * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.14 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.14 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.30 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 <string.h>
25:
1.58 kristaps 26: #include "man.h"
1.46 kristaps 27: #include "mandoc.h"
1.57 kristaps 28: #include "libmandoc.h"
1.1 kristaps 29: #include "libman.h"
30:
1.34 kristaps 31: enum rew {
32: REW_REWIND,
33: REW_NOHALT,
1.40 kristaps 34: REW_HALT
1.34 kristaps 35: };
1.19 kristaps 36:
1.35 kristaps 37: static int blk_close(MACRO_PROT_ARGS);
38: static int blk_exp(MACRO_PROT_ARGS);
39: static int blk_imp(MACRO_PROT_ARGS);
1.19 kristaps 40: static int in_line_eoln(MACRO_PROT_ARGS);
1.60 ! kristaps 41: static int man_args(struct man *, int,
! 42: int *, char *, char **);
1.19 kristaps 43:
1.33 kristaps 44: static int rew_scope(enum man_type,
45: struct man *, enum mant);
1.34 kristaps 46: static enum rew rew_dohalt(enum mant, enum man_type,
1.19 kristaps 47: const struct man_node *);
1.34 kristaps 48: static enum rew rew_block(enum mant, enum man_type,
1.21 kristaps 49: const struct man_node *);
1.56 kristaps 50: static void rew_warn(struct man *,
1.46 kristaps 51: struct man_node *, enum mandocerr);
1.19 kristaps 52:
53: const struct man_macro __man_macros[MAN_MAX] = {
1.31 kristaps 54: { in_line_eoln, MAN_NSCOPED }, /* br */
1.19 kristaps 55: { in_line_eoln, 0 }, /* TH */
1.24 kristaps 56: { blk_imp, MAN_SCOPED }, /* SH */
57: { blk_imp, MAN_SCOPED }, /* SS */
1.27 kristaps 58: { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */
1.19 kristaps 59: { blk_imp, 0 }, /* LP */
60: { blk_imp, 0 }, /* PP */
61: { blk_imp, 0 }, /* P */
62: { blk_imp, 0 }, /* IP */
63: { blk_imp, 0 }, /* HP */
64: { in_line_eoln, MAN_SCOPED }, /* SM */
65: { in_line_eoln, MAN_SCOPED }, /* SB */
66: { in_line_eoln, 0 }, /* BI */
67: { in_line_eoln, 0 }, /* IB */
68: { in_line_eoln, 0 }, /* BR */
69: { in_line_eoln, 0 }, /* RB */
70: { in_line_eoln, MAN_SCOPED }, /* R */
71: { in_line_eoln, MAN_SCOPED }, /* B */
72: { in_line_eoln, MAN_SCOPED }, /* I */
73: { in_line_eoln, 0 }, /* IR */
74: { in_line_eoln, 0 }, /* RI */
1.31 kristaps 75: { in_line_eoln, MAN_NSCOPED }, /* na */
76: { in_line_eoln, MAN_NSCOPED }, /* sp */
1.19 kristaps 77: { in_line_eoln, 0 }, /* nf */
78: { in_line_eoln, 0 }, /* fi */
1.21 kristaps 79: { blk_close, 0 }, /* RE */
1.35 kristaps 80: { blk_exp, MAN_EXPLICIT }, /* RS */
1.23 kristaps 81: { in_line_eoln, 0 }, /* DT */
1.28 kristaps 82: { in_line_eoln, 0 }, /* UC */
1.29 kristaps 83: { in_line_eoln, 0 }, /* PD */
1.45 joerg 84: { in_line_eoln, 0 }, /* AT */
1.49 kristaps 85: { in_line_eoln, 0 }, /* in */
1.53 kristaps 86: { in_line_eoln, 0 }, /* ft */
1.19 kristaps 87: };
1.9 kristaps 88:
1.19 kristaps 89: const struct man_macro * const man_macros = __man_macros;
1.1 kristaps 90:
91:
1.38 kristaps 92: /*
93: * Warn when "n" is an explicit non-roff macro.
94: */
1.56 kristaps 95: static void
1.46 kristaps 96: rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
1.38 kristaps 97: {
98:
1.46 kristaps 99: if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
1.56 kristaps 100: return;
1.38 kristaps 101: if (MAN_VALID & n->flags)
1.56 kristaps 102: return;
1.38 kristaps 103: if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
1.56 kristaps 104: return;
105:
106: assert(er < MANDOCERR_FATAL);
107: man_nmsg(m, n, er);
1.38 kristaps 108: }
109:
110:
111: /*
1.46 kristaps 112: * Rewind scope. If a code "er" != MANDOCERR_MAX has been provided, it
113: * will be used if an explicit block scope is being closed out.
1.38 kristaps 114: */
1.3 kristaps 115: int
1.55 kristaps 116: man_unscope(struct man *m, const struct man_node *to,
1.46 kristaps 117: enum mandocerr er)
1.1 kristaps 118: {
1.55 kristaps 119: struct man_node *n;
1.1 kristaps 120:
1.55 kristaps 121: assert(to);
1.19 kristaps 122:
123: /* LINTED */
1.55 kristaps 124: while (m->last != to) {
125: /*
126: * Save the parent here, because we may delete the
127: * m->last node in the post-validation phase and reset
128: * it to m->last->parent, causing a step in the closing
129: * out to be lost.
130: */
131: n = m->last->parent;
1.56 kristaps 132: rew_warn(m, m->last, er);
1.19 kristaps 133: if ( ! man_valid_post(m))
134: return(0);
1.55 kristaps 135: m->last = n;
1.19 kristaps 136: assert(m->last);
137: }
138:
1.56 kristaps 139: rew_warn(m, m->last, er);
1.19 kristaps 140: if ( ! man_valid_post(m))
1.1 kristaps 141: return(0);
1.35 kristaps 142:
143: m->next = MAN_ROOT == m->last->type ?
144: MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
145:
146: return(1);
1.19 kristaps 147: }
1.1 kristaps 148:
149:
1.34 kristaps 150: static enum rew
1.33 kristaps 151: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.21 kristaps 152: {
153:
154: if (MAN_BLOCK == type && ntok == n->parent->tok &&
155: MAN_BODY == n->parent->type)
156: return(REW_REWIND);
157: return(ntok == n->tok ? REW_HALT : REW_NOHALT);
158: }
159:
160:
1.19 kristaps 161: /*
162: * There are three scope levels: scoped to the root (all), scoped to the
163: * section (all less sections), and scoped to subsections (all less
164: * sections and subsections).
165: */
1.34 kristaps 166: static enum rew
1.33 kristaps 167: rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
1.19 kristaps 168: {
1.34 kristaps 169: enum rew c;
1.1 kristaps 170:
1.38 kristaps 171: /* We cannot progress beyond the root ever. */
1.19 kristaps 172: if (MAN_ROOT == n->type)
173: return(REW_HALT);
1.38 kristaps 174:
1.19 kristaps 175: assert(n->parent);
1.38 kristaps 176:
177: /* Normal nodes shouldn't go to the level of the root. */
1.19 kristaps 178: if (MAN_ROOT == n->parent->type)
179: return(REW_REWIND);
1.38 kristaps 180:
181: /* Already-validated nodes should be closed out. */
1.19 kristaps 182: if (MAN_VALID & n->flags)
183: return(REW_NOHALT);
184:
1.38 kristaps 185: /* First: rewind to ourselves. */
1.21 kristaps 186: if (type == n->type && tok == n->tok)
187: return(REW_REWIND);
188:
1.38 kristaps 189: /*
190: * Next follow the implicit scope-smashings as defined by man.7:
191: * section, sub-section, etc.
192: */
193:
1.19 kristaps 194: switch (tok) {
195: case (MAN_SH):
196: break;
197: case (MAN_SS):
1.20 kristaps 198: /* Rewind to a section, if a block. */
1.21 kristaps 199: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
200: return(c);
201: break;
202: case (MAN_RS):
203: /* Rewind to a subsection, if a block. */
204: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
205: return(c);
206: /* Rewind to a section, if a block. */
207: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
208: return(c);
1.19 kristaps 209: break;
210: default:
1.21 kristaps 211: /* Rewind to an offsetter, if a block. */
212: if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
213: return(c);
1.20 kristaps 214: /* Rewind to a subsection, if a block. */
1.21 kristaps 215: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
216: return(c);
1.20 kristaps 217: /* Rewind to a section, if a block. */
1.21 kristaps 218: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
219: return(c);
1.19 kristaps 220: break;
1.3 kristaps 221: }
1.1 kristaps 222:
1.19 kristaps 223: return(REW_NOHALT);
224: }
1.9 kristaps 225:
226:
1.19 kristaps 227: /*
228: * Rewinding entails ascending the parse tree until a coherent point,
229: * for example, the `SH' macro will close out any intervening `SS'
230: * scopes. When a scope is closed, it must be validated and actioned.
231: */
232: static int
1.33 kristaps 233: rew_scope(enum man_type type, struct man *m, enum mant tok)
1.19 kristaps 234: {
235: struct man_node *n;
1.34 kristaps 236: enum rew c;
1.7 kristaps 237:
1.19 kristaps 238: /* LINTED */
239: for (n = m->last; n; n = n->parent) {
240: /*
241: * Whether we should stop immediately (REW_HALT), stop
242: * and rewind until this point (REW_REWIND), or keep
243: * rewinding (REW_NOHALT).
244: */
245: c = rew_dohalt(tok, type, n);
246: if (REW_HALT == c)
247: return(1);
248: if (REW_REWIND == c)
1.7 kristaps 249: break;
1.6 kristaps 250: }
1.1 kristaps 251:
1.38 kristaps 252: /*
253: * Rewind until the current point. Warn if we're a roff
254: * instruction that's mowing over explicit scopes.
255: */
256: assert(n);
1.19 kristaps 257:
1.46 kristaps 258: return(man_unscope(m, n, MANDOCERR_MAX));
1.19 kristaps 259: }
260:
1.6 kristaps 261:
1.36 kristaps 262: /*
263: * Close out a generic explicit macro.
264: */
1.37 kristaps 265: /* ARGSUSED */
1.35 kristaps 266: int
1.21 kristaps 267: blk_close(MACRO_PROT_ARGS)
268: {
1.33 kristaps 269: enum mant ntok;
1.21 kristaps 270: const struct man_node *nn;
271:
272: switch (tok) {
273: case (MAN_RE):
274: ntok = MAN_RS;
275: break;
276: default:
277: abort();
278: /* NOTREACHED */
279: }
280:
281: for (nn = m->last->parent; nn; nn = nn->parent)
282: if (ntok == nn->tok)
283: break;
284:
285: if (NULL == nn)
1.56 kristaps 286: man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
1.21 kristaps 287:
288: if ( ! rew_scope(MAN_BODY, m, ntok))
289: return(0);
290: if ( ! rew_scope(MAN_BLOCK, m, ntok))
291: return(0);
1.35 kristaps 292:
1.21 kristaps 293: return(1);
294: }
295:
296:
1.48 kristaps 297: /* ARGSUSED */
1.35 kristaps 298: int
299: blk_exp(MACRO_PROT_ARGS)
300: {
1.59 kristaps 301: int la;
1.35 kristaps 302: char *p;
303:
304: /*
305: * Close out prior scopes. "Regular" explicit macros cannot be
306: * nested, but we allow roff macros to be placed just about
307: * anywhere.
308: */
309:
1.44 kristaps 310: if ( ! rew_scope(MAN_BODY, m, tok))
311: return(0);
312: if ( ! rew_scope(MAN_BLOCK, m, tok))
313: return(0);
1.35 kristaps 314:
315: if ( ! man_block_alloc(m, line, ppos, tok))
316: return(0);
317: if ( ! man_head_alloc(m, line, ppos, tok))
318: return(0);
319:
320: for (;;) {
321: la = *pos;
1.60 ! kristaps 322: if ( ! man_args(m, line, pos, buf, &p))
1.35 kristaps 323: break;
324: if ( ! man_word_alloc(m, line, la, p))
325: return(0);
326: }
327:
328: assert(m);
329: assert(tok != MAN_MAX);
330:
331: if ( ! rew_scope(MAN_HEAD, m, tok))
332: return(0);
333: return(man_body_alloc(m, line, ppos, tok));
334: }
335:
336:
337:
1.19 kristaps 338: /*
339: * Parse an implicit-block macro. These contain a MAN_HEAD and a
340: * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
341: * scopes, such as `SH' closing out an `SS', are defined in the rew
342: * routines.
343: */
1.48 kristaps 344: /* ARGSUSED */
1.19 kristaps 345: int
346: blk_imp(MACRO_PROT_ARGS)
347: {
1.59 kristaps 348: int la;
1.19 kristaps 349: char *p;
1.25 kristaps 350: struct man_node *n;
1.19 kristaps 351:
352: /* Close out prior scopes. */
1.7 kristaps 353:
1.19 kristaps 354: if ( ! rew_scope(MAN_BODY, m, tok))
1.5 kristaps 355: return(0);
1.19 kristaps 356: if ( ! rew_scope(MAN_BLOCK, m, tok))
1.6 kristaps 357: return(0);
1.1 kristaps 358:
1.19 kristaps 359: /* Allocate new block & head scope. */
360:
361: if ( ! man_block_alloc(m, line, ppos, tok))
362: return(0);
363: if ( ! man_head_alloc(m, line, ppos, tok))
364: return(0);
1.1 kristaps 365:
1.25 kristaps 366: n = m->last;
367:
1.19 kristaps 368: /* Add line arguments. */
1.3 kristaps 369:
1.19 kristaps 370: for (;;) {
371: la = *pos;
1.60 ! kristaps 372: if ( ! man_args(m, line, pos, buf, &p))
1.19 kristaps 373: break;
374: if ( ! man_word_alloc(m, line, la, p))
1.6 kristaps 375: return(0);
376: }
377:
1.19 kristaps 378: /* Close out head and open body (unless MAN_SCOPE). */
379:
1.27 kristaps 380: if (MAN_SCOPED & man_macros[tok].flags) {
381: /* If we're forcing scope (`TP'), keep it open. */
382: if (MAN_FSCOPED & man_macros[tok].flags) {
383: m->flags |= MAN_BLINE;
384: return(1);
385: } else if (n == m->last) {
386: m->flags |= MAN_BLINE;
387: return(1);
388: }
389: }
390:
391: if ( ! rew_scope(MAN_HEAD, m, tok))
1.6 kristaps 392: return(0);
1.19 kristaps 393: return(man_body_alloc(m, line, ppos, tok));
1.4 kristaps 394: }
395:
396:
1.48 kristaps 397: /* ARGSUSED */
1.19 kristaps 398: int
399: in_line_eoln(MACRO_PROT_ARGS)
1.3 kristaps 400: {
1.59 kristaps 401: int la;
1.19 kristaps 402: char *p;
403: struct man_node *n;
1.3 kristaps 404:
1.19 kristaps 405: if ( ! man_elem_alloc(m, line, ppos, tok))
1.3 kristaps 406: return(0);
407:
1.19 kristaps 408: n = m->last;
1.3 kristaps 409:
1.19 kristaps 410: for (;;) {
411: la = *pos;
1.60 ! kristaps 412: if ( ! man_args(m, line, pos, buf, &p))
1.19 kristaps 413: break;
414: if ( ! man_word_alloc(m, line, la, p))
415: return(0);
416: }
1.3 kristaps 417:
1.31 kristaps 418: /*
419: * If no arguments are specified and this is MAN_SCOPED (i.e.,
420: * next-line scoped), then set our mode to indicate that we're
421: * waiting for terms to load into our context.
422: */
423:
1.25 kristaps 424: if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
1.31 kristaps 425: assert( ! (MAN_NSCOPED & man_macros[tok].flags));
1.19 kristaps 426: m->flags |= MAN_ELINE;
427: return(1);
428: }
1.3 kristaps 429:
1.31 kristaps 430: /* Set ignorable context, if applicable. */
431:
432: if (MAN_NSCOPED & man_macros[tok].flags) {
433: assert( ! (MAN_SCOPED & man_macros[tok].flags));
434: m->flags |= MAN_ILINE;
435: }
436:
1.19 kristaps 437: /*
1.31 kristaps 438: * Rewind our element scope. Note that when TH is pruned, we'll
439: * be back at the root, so make sure that we don't clobber as
440: * its sibling.
1.19 kristaps 441: */
1.3 kristaps 442:
1.19 kristaps 443: for ( ; m->last; m->last = m->last->parent) {
444: if (m->last == n)
445: break;
446: if (m->last->type == MAN_ROOT)
447: break;
448: if ( ! man_valid_post(m))
449: return(0);
450: }
1.3 kristaps 451:
1.19 kristaps 452: assert(m->last);
1.3 kristaps 453:
454: /*
1.19 kristaps 455: * Same here regarding whether we're back at the root.
1.3 kristaps 456: */
457:
1.19 kristaps 458: if (m->last->type != MAN_ROOT && ! man_valid_post(m))
459: return(0);
1.35 kristaps 460:
461: m->next = MAN_ROOT == m->last->type ?
462: MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
1.3 kristaps 463:
1.19 kristaps 464: return(1);
465: }
1.3 kristaps 466:
467:
1.19 kristaps 468: int
469: man_macroend(struct man *m)
470: {
1.22 kristaps 471:
1.46 kristaps 472: return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));
1.19 kristaps 473: }
1.3 kristaps 474:
1.60 ! kristaps 475: static int
! 476: man_args(struct man *m, int line, int *pos, char *buf, char **v)
! 477: {
! 478: char *start;
! 479:
! 480: assert(*pos);
! 481: *v = start = buf + *pos;
! 482: assert(' ' != *start);
! 483:
! 484: if ('\0' == *start)
! 485: return(0);
! 486:
! 487: *v = mandoc_getarg(m->parse, v, line, pos);
! 488: return(1);
! 489: }
CVSweb