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