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