Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.46
1.46 ! schwarze 1: /* $Id: man_macro.c,v 1.45 2014/04/20 16:44:44 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.45 schwarze 39: static int man_args(struct man *, int,
1.29 schwarze 40: int *, char *, char **);
1.6 schwarze 41:
1.45 schwarze 42: static int rew_scope(enum man_type,
1.12 schwarze 43: struct man *, enum mant);
1.45 schwarze 44: static enum rew rew_dohalt(enum mant, enum man_type,
1.6 schwarze 45: const struct man_node *);
1.45 schwarze 46: static enum rew rew_block(enum mant, enum man_type,
1.7 schwarze 47: const struct man_node *);
1.45 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:
96: int
1.46 ! schwarze 97: man_unscope(struct man *man, const struct man_node *to)
1.1 kristaps 98: {
1.27 schwarze 99: struct man_node *n;
1.1 kristaps 100:
1.38 schwarze 101: man->next = MAN_NEXT_SIBLING;
1.46 ! schwarze 102: to = to->parent;
! 103: n = man->last;
! 104: while (n != to) {
! 105: if (NULL == to &&
! 106: MAN_BLOCK == n->type &&
! 107: 0 == (MAN_VALID & n->flags) &&
! 108: MAN_EXPLICIT & man_macros[n->tok].flags)
! 109: mandoc_msg(MANDOCERR_SCOPEEXIT,
! 110: man->parse, n->line, n->pos,
! 111: man_macronames[n->tok]);
1.27 schwarze 112: /*
1.46 ! schwarze 113: * We might delete the man->last node
! 114: * in the post-validation phase.
! 115: * Save a pointer to the parent such that
! 116: * we know where to continue the iteration.
1.27 schwarze 117: */
1.46 ! schwarze 118: man->last = n;
! 119: n = n->parent;
1.38 schwarze 120: if ( ! man_valid_post(man))
1.6 schwarze 121: return(0);
122: }
1.12 schwarze 123: return(1);
1.6 schwarze 124: }
1.1 kristaps 125:
1.12 schwarze 126: static enum rew
127: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.7 schwarze 128: {
129:
1.45 schwarze 130: if (MAN_BLOCK == type && ntok == n->parent->tok &&
131: MAN_BODY == n->parent->type)
1.7 schwarze 132: return(REW_REWIND);
133: return(ntok == n->tok ? REW_HALT : REW_NOHALT);
134: }
135:
1.6 schwarze 136: /*
137: * There are three scope levels: scoped to the root (all), scoped to the
138: * section (all less sections), and scoped to subsections (all less
139: * sections and subsections).
140: */
1.45 schwarze 141: static enum rew
1.12 schwarze 142: rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
1.6 schwarze 143: {
1.12 schwarze 144: enum rew c;
1.1 kristaps 145:
1.13 schwarze 146: /* We cannot progress beyond the root ever. */
1.6 schwarze 147: if (MAN_ROOT == n->type)
148: return(REW_HALT);
1.13 schwarze 149:
1.6 schwarze 150: assert(n->parent);
1.13 schwarze 151:
152: /* Normal nodes shouldn't go to the level of the root. */
1.6 schwarze 153: if (MAN_ROOT == n->parent->type)
154: return(REW_REWIND);
1.13 schwarze 155:
156: /* Already-validated nodes should be closed out. */
1.6 schwarze 157: if (MAN_VALID & n->flags)
158: return(REW_NOHALT);
159:
1.13 schwarze 160: /* First: rewind to ourselves. */
1.36 schwarze 161: if (type == n->type && tok == n->tok) {
162: if (MAN_EXPLICIT & man_macros[n->tok].flags)
163: return(REW_HALT);
164: else
165: return(REW_REWIND);
166: }
1.7 schwarze 167:
1.45 schwarze 168: /*
1.13 schwarze 169: * Next follow the implicit scope-smashings as defined by man.7:
170: * section, sub-section, etc.
171: */
172:
1.6 schwarze 173: switch (tok) {
1.45 schwarze 174: case MAN_SH:
1.6 schwarze 175: break;
1.45 schwarze 176: case MAN_SS:
1.6 schwarze 177: /* Rewind to a section, if a block. */
1.7 schwarze 178: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
179: return(c);
180: break;
1.45 schwarze 181: case MAN_RS:
1.36 schwarze 182: /* Preserve empty paragraphs before RS. */
183: if (0 == n->nchild && (MAN_P == n->tok ||
184: MAN_PP == n->tok || MAN_LP == n->tok))
185: return(REW_HALT);
1.7 schwarze 186: /* Rewind to a subsection, if a block. */
187: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
188: return(c);
189: /* Rewind to a section, if a block. */
190: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
191: return(c);
1.6 schwarze 192: break;
193: default:
1.7 schwarze 194: /* Rewind to an offsetter, if a block. */
195: if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
196: return(c);
1.6 schwarze 197: /* Rewind to a subsection, if a block. */
1.7 schwarze 198: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
199: return(c);
1.6 schwarze 200: /* Rewind to a section, if a block. */
1.7 schwarze 201: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
202: return(c);
1.6 schwarze 203: break;
1.1 kristaps 204: }
205:
1.6 schwarze 206: return(REW_NOHALT);
207: }
1.1 kristaps 208:
1.6 schwarze 209: /*
210: * Rewinding entails ascending the parse tree until a coherent point,
211: * for example, the `SH' macro will close out any intervening `SS'
212: * scopes. When a scope is closed, it must be validated and actioned.
213: */
214: static int
1.38 schwarze 215: rew_scope(enum man_type type, struct man *man, enum mant tok)
1.6 schwarze 216: {
217: struct man_node *n;
1.12 schwarze 218: enum rew c;
1.1 kristaps 219:
1.38 schwarze 220: for (n = man->last; n; n = n->parent) {
1.45 schwarze 221: /*
1.6 schwarze 222: * Whether we should stop immediately (REW_HALT), stop
223: * and rewind until this point (REW_REWIND), or keep
224: * rewinding (REW_NOHALT).
225: */
226: c = rew_dohalt(tok, type, n);
227: if (REW_HALT == c)
228: return(1);
229: if (REW_REWIND == c)
1.1 kristaps 230: break;
231: }
232:
1.45 schwarze 233: /*
1.13 schwarze 234: * Rewind until the current point. Warn if we're a roff
235: * instruction that's mowing over explicit scopes.
236: */
237: assert(n);
1.6 schwarze 238:
1.46 ! schwarze 239: return(man_unscope(man, n));
1.6 schwarze 240: }
241:
1.1 kristaps 242:
1.12 schwarze 243: /*
244: * Close out a generic explicit macro.
245: */
1.7 schwarze 246: int
247: blk_close(MACRO_PROT_ARGS)
248: {
1.45 schwarze 249: enum mant ntok;
1.7 schwarze 250: const struct man_node *nn;
251:
252: switch (tok) {
1.45 schwarze 253: case MAN_RE:
1.7 schwarze 254: ntok = MAN_RS;
1.39 schwarze 255: break;
1.45 schwarze 256: case MAN_UE:
1.39 schwarze 257: ntok = MAN_UR;
1.7 schwarze 258: break;
259: default:
260: abort();
261: /* NOTREACHED */
262: }
263:
1.38 schwarze 264: for (nn = man->last->parent; nn; nn = nn->parent)
1.36 schwarze 265: if (ntok == nn->tok && MAN_BLOCK == nn->type)
1.7 schwarze 266: break;
267:
1.40 schwarze 268: if (NULL == nn) {
269: man_pmsg(man, line, ppos, MANDOCERR_NOSCOPE);
270: if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))
271: return(0);
1.45 schwarze 272: } else
1.46 ! schwarze 273: man_unscope(man, nn);
1.7 schwarze 274:
275: return(1);
276: }
277:
1.12 schwarze 278: int
279: blk_exp(MACRO_PROT_ARGS)
280: {
1.36 schwarze 281: struct man_node *n;
1.29 schwarze 282: int la;
1.12 schwarze 283: char *p;
284:
1.36 schwarze 285: /* Close out prior implicit scopes. */
286:
1.38 schwarze 287: if ( ! rew_scope(MAN_BLOCK, man, tok))
1.36 schwarze 288: return(0);
1.12 schwarze 289:
1.38 schwarze 290: if ( ! man_block_alloc(man, line, ppos, tok))
1.12 schwarze 291: return(0);
1.38 schwarze 292: if ( ! man_head_alloc(man, line, ppos, tok))
1.12 schwarze 293: return(0);
294:
295: for (;;) {
296: la = *pos;
1.38 schwarze 297: if ( ! man_args(man, line, pos, buf, &p))
1.12 schwarze 298: break;
1.38 schwarze 299: if ( ! man_word_alloc(man, line, la, p))
1.12 schwarze 300: return(0);
301: }
302:
1.38 schwarze 303: assert(man);
1.12 schwarze 304: assert(tok != MAN_MAX);
305:
1.38 schwarze 306: for (n = man->last; n; n = n->parent) {
1.36 schwarze 307: if (n->tok != tok)
308: continue;
309: assert(MAN_HEAD == n->type);
1.46 ! schwarze 310: man_unscope(man, n);
1.36 schwarze 311: break;
312: }
313:
1.38 schwarze 314: return(man_body_alloc(man, line, ppos, tok));
1.12 schwarze 315: }
316:
1.6 schwarze 317: /*
318: * Parse an implicit-block macro. These contain a MAN_HEAD and a
319: * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
320: * scopes, such as `SH' closing out an `SS', are defined in the rew
321: * routines.
322: */
323: int
324: blk_imp(MACRO_PROT_ARGS)
325: {
1.29 schwarze 326: int la;
1.6 schwarze 327: char *p;
1.7 schwarze 328: struct man_node *n;
1.6 schwarze 329:
330: /* Close out prior scopes. */
1.1 kristaps 331:
1.38 schwarze 332: if ( ! rew_scope(MAN_BODY, man, tok))
1.1 kristaps 333: return(0);
1.38 schwarze 334: if ( ! rew_scope(MAN_BLOCK, man, tok))
1.1 kristaps 335: return(0);
336:
1.6 schwarze 337: /* Allocate new block & head scope. */
338:
1.38 schwarze 339: if ( ! man_block_alloc(man, line, ppos, tok))
1.6 schwarze 340: return(0);
1.38 schwarze 341: if ( ! man_head_alloc(man, line, ppos, tok))
1.6 schwarze 342: return(0);
1.1 kristaps 343:
1.38 schwarze 344: n = man->last;
1.7 schwarze 345:
1.6 schwarze 346: /* Add line arguments. */
1.1 kristaps 347:
1.6 schwarze 348: for (;;) {
349: la = *pos;
1.38 schwarze 350: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 351: break;
1.38 schwarze 352: if ( ! man_word_alloc(man, line, la, p))
1.1 kristaps 353: return(0);
354: }
355:
1.6 schwarze 356: /* Close out head and open body (unless MAN_SCOPE). */
357:
358: if (MAN_SCOPED & man_macros[tok].flags) {
1.7 schwarze 359: /* If we're forcing scope (`TP'), keep it open. */
360: if (MAN_FSCOPED & man_macros[tok].flags) {
1.38 schwarze 361: man->flags |= MAN_BLINE;
1.7 schwarze 362: return(1);
1.38 schwarze 363: } else if (n == man->last) {
364: man->flags |= MAN_BLINE;
1.7 schwarze 365: return(1);
366: }
367: }
368:
1.38 schwarze 369: if ( ! rew_scope(MAN_HEAD, man, tok))
1.1 kristaps 370: return(0);
1.38 schwarze 371: return(man_body_alloc(man, line, ppos, tok));
1.1 kristaps 372: }
373:
1.6 schwarze 374: int
375: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 376: {
1.29 schwarze 377: int la;
1.6 schwarze 378: char *p;
379: struct man_node *n;
1.1 kristaps 380:
1.38 schwarze 381: if ( ! man_elem_alloc(man, line, ppos, tok))
1.1 kristaps 382: return(0);
383:
1.38 schwarze 384: n = man->last;
1.1 kristaps 385:
1.6 schwarze 386: for (;;) {
387: la = *pos;
1.38 schwarze 388: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 389: break;
1.38 schwarze 390: if ( ! man_word_alloc(man, line, la, p))
1.6 schwarze 391: return(0);
392: }
1.41 schwarze 393:
394: /*
395: * Append MAN_EOS in case the last snipped argument
396: * ends with a dot, e.g. `.IR syslog (3).'
397: */
398:
399: if (n != man->last &&
1.43 schwarze 400: mandoc_eos(man->last->string, strlen(man->last->string)))
1.41 schwarze 401: man->last->flags |= MAN_EOS;
1.1 kristaps 402:
1.11 schwarze 403: /*
404: * If no arguments are specified and this is MAN_SCOPED (i.e.,
405: * next-line scoped), then set our mode to indicate that we're
406: * waiting for terms to load into our context.
407: */
408:
1.38 schwarze 409: if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {
1.11 schwarze 410: assert( ! (MAN_NSCOPED & man_macros[tok].flags));
1.38 schwarze 411: man->flags |= MAN_ELINE;
1.6 schwarze 412: return(1);
1.45 schwarze 413: }
1.1 kristaps 414:
1.11 schwarze 415: /* Set ignorable context, if applicable. */
416:
417: if (MAN_NSCOPED & man_macros[tok].flags) {
418: assert( ! (MAN_SCOPED & man_macros[tok].flags));
1.38 schwarze 419: man->flags |= MAN_ILINE;
1.11 schwarze 420: }
1.31 schwarze 421:
1.38 schwarze 422: assert(MAN_ROOT != man->last->type);
423: man->next = MAN_NEXT_SIBLING;
1.45 schwarze 424:
1.6 schwarze 425: /*
1.11 schwarze 426: * Rewind our element scope. Note that when TH is pruned, we'll
427: * be back at the root, so make sure that we don't clobber as
428: * its sibling.
1.6 schwarze 429: */
1.1 kristaps 430:
1.38 schwarze 431: for ( ; man->last; man->last = man->last->parent) {
432: if (man->last == n)
1.6 schwarze 433: break;
1.38 schwarze 434: if (man->last->type == MAN_ROOT)
1.6 schwarze 435: break;
1.38 schwarze 436: if ( ! man_valid_post(man))
1.6 schwarze 437: return(0);
438: }
1.1 kristaps 439:
1.38 schwarze 440: assert(man->last);
1.1 kristaps 441:
442: /*
1.45 schwarze 443: * Same here regarding whether we're back at the root.
1.1 kristaps 444: */
445:
1.38 schwarze 446: if (man->last->type != MAN_ROOT && ! man_valid_post(man))
1.6 schwarze 447: return(0);
1.1 kristaps 448:
1.6 schwarze 449: return(1);
450: }
1.1 kristaps 451:
452:
1.6 schwarze 453: int
1.38 schwarze 454: man_macroend(struct man *man)
1.6 schwarze 455: {
1.1 kristaps 456:
1.46 ! schwarze 457: return(man_unscope(man, man->first));
1.6 schwarze 458: }
1.1 kristaps 459:
1.29 schwarze 460: static int
1.38 schwarze 461: man_args(struct man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 462: {
463: char *start;
464:
465: assert(*pos);
466: *v = start = buf + *pos;
467: assert(' ' != *start);
468:
469: if ('\0' == *start)
470: return(0);
471:
1.38 schwarze 472: *v = mandoc_getarg(man->parse, v, line, pos);
1.29 schwarze 473: return(1);
474: }
![[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