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