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