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