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