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