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