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