Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.73
1.73 ! schwarze 1: /* $OpenBSD: man_macro.c,v 1.72 2015/09/04 21:24:26 schwarze Exp $ */
1.1 kristaps 2: /*
1.29 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.55 schwarze 4: * Copyright (c) 2012, 2013, 2014, 2015 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.63 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.63 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 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.63 schwarze 26: #include "mandoc.h"
27: #include "roff.h"
1.29 schwarze 28: #include "man.h"
29: #include "libmandoc.h"
1.68 schwarze 30: #include "roff_int.h"
1.1 kristaps 31: #include "libman.h"
32:
1.53 schwarze 33: static void blk_close(MACRO_PROT_ARGS);
34: static void blk_exp(MACRO_PROT_ARGS);
35: static void blk_imp(MACRO_PROT_ARGS);
36: static void in_line_eoln(MACRO_PROT_ARGS);
1.67 schwarze 37: static int man_args(struct roff_man *, int,
1.29 schwarze 38: int *, char *, char **);
1.67 schwarze 39: static void rew_scope(struct roff_man *, int);
1.6 schwarze 40:
41: const struct man_macro __man_macros[MAN_MAX] = {
1.11 schwarze 42: { in_line_eoln, MAN_NSCOPED }, /* br */
1.32 schwarze 43: { in_line_eoln, MAN_BSCOPE }, /* TH */
44: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
45: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
1.61 schwarze 46: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TP */
1.32 schwarze 47: { blk_imp, MAN_BSCOPE }, /* LP */
48: { blk_imp, MAN_BSCOPE }, /* PP */
49: { blk_imp, MAN_BSCOPE }, /* P */
50: { blk_imp, MAN_BSCOPE }, /* IP */
51: { blk_imp, MAN_BSCOPE }, /* HP */
1.52 schwarze 52: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
53: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
1.6 schwarze 54: { in_line_eoln, 0 }, /* BI */
55: { in_line_eoln, 0 }, /* IB */
56: { in_line_eoln, 0 }, /* BR */
57: { in_line_eoln, 0 }, /* RB */
1.52 schwarze 58: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
59: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
60: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
1.6 schwarze 61: { in_line_eoln, 0 }, /* IR */
62: { in_line_eoln, 0 }, /* RI */
1.11 schwarze 63: { in_line_eoln, MAN_NSCOPED }, /* sp */
1.72 schwarze 64: { in_line_eoln, MAN_NSCOPED }, /* nf */
65: { in_line_eoln, MAN_NSCOPED }, /* fi */
1.54 schwarze 66: { blk_close, MAN_BSCOPE }, /* RE */
1.61 schwarze 67: { blk_exp, MAN_BSCOPE }, /* RS */
1.7 schwarze 68: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 69: { in_line_eoln, 0 }, /* UC */
1.62 schwarze 70: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.18 schwarze 71: { in_line_eoln, 0 }, /* AT */
1.20 schwarze 72: { in_line_eoln, 0 }, /* in */
1.22 schwarze 73: { in_line_eoln, 0 }, /* ft */
1.34 schwarze 74: { in_line_eoln, 0 }, /* OP */
1.35 schwarze 75: { in_line_eoln, MAN_BSCOPE }, /* EX */
76: { in_line_eoln, MAN_BSCOPE }, /* EE */
1.61 schwarze 77: { blk_exp, MAN_BSCOPE }, /* UR */
1.54 schwarze 78: { blk_close, MAN_BSCOPE }, /* UE */
1.44 schwarze 79: { in_line_eoln, 0 }, /* ll */
1.6 schwarze 80: };
1.1 kristaps 81:
1.6 schwarze 82: const struct man_macro * const man_macros = __man_macros;
1.1 kristaps 83:
84:
1.53 schwarze 85: void
1.67 schwarze 86: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1 kristaps 87: {
1.64 schwarze 88: struct roff_node *n;
1.1 kristaps 89:
1.46 schwarze 90: to = to->parent;
91: n = man->last;
92: while (n != to) {
1.50 schwarze 93:
94: /* Reached the end of the document? */
95:
96: if (to == NULL && ! (n->flags & MAN_VALID)) {
97: if (man->flags & (MAN_BLINE | MAN_ELINE) &&
98: man_macros[n->tok].flags & MAN_SCOPED) {
99: mandoc_vmsg(MANDOCERR_BLK_LINE,
100: man->parse, n->line, n->pos,
101: "EOF breaks %s",
102: man_macronames[n->tok]);
103: if (man->flags & MAN_ELINE)
104: man->flags &= ~MAN_ELINE;
105: else {
1.63 schwarze 106: assert(n->type == ROFFT_HEAD);
1.50 schwarze 107: n = n->parent;
108: man->flags &= ~MAN_BLINE;
109: }
110: man->last = n;
111: n = n->parent;
1.68 schwarze 112: roff_node_delete(man, man->last);
1.50 schwarze 113: continue;
114: }
1.63 schwarze 115: if (n->type == ROFFT_BLOCK &&
1.61 schwarze 116: man_macros[n->tok].fp == blk_exp)
1.50 schwarze 117: mandoc_msg(MANDOCERR_BLK_NOEND,
118: man->parse, n->line, n->pos,
119: man_macronames[n->tok]);
120: }
121:
1.27 schwarze 122: /*
1.46 schwarze 123: * We might delete the man->last node
124: * in the post-validation phase.
125: * Save a pointer to the parent such that
126: * we know where to continue the iteration.
1.27 schwarze 127: */
1.51 schwarze 128:
1.46 schwarze 129: man->last = n;
130: n = n->parent;
1.53 schwarze 131: man_valid_post(man);
1.6 schwarze 132: }
1.51 schwarze 133:
134: /*
135: * If we ended up at the parent of the node we were
136: * supposed to rewind to, that means the target node
137: * got deleted, so add the next node we parse as a child
138: * of the parent instead of as a sibling of the target.
139: */
140:
141: man->next = (man->last == to) ?
1.67 schwarze 142: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.6 schwarze 143: }
1.1 kristaps 144:
1.6 schwarze 145: /*
146: * Rewinding entails ascending the parse tree until a coherent point,
147: * for example, the `SH' macro will close out any intervening `SS'
148: * scopes. When a scope is closed, it must be validated and actioned.
149: */
1.53 schwarze 150: static void
1.67 schwarze 151: rew_scope(struct roff_man *man, int tok)
1.6 schwarze 152: {
1.64 schwarze 153: struct roff_node *n;
1.1 kristaps 154:
1.66 schwarze 155: /* Preserve empty paragraphs before RS. */
156:
157: n = man->last;
158: if (tok == MAN_RS && n->nchild == 0 &&
159: (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
160: return;
161:
162: for (;;) {
163: if (n->type == ROFFT_ROOT)
164: return;
165: if (n->flags & MAN_VALID) {
166: n = n->parent;
167: continue;
168: }
169: if (n->type != ROFFT_BLOCK) {
170: if (n->parent->type == ROFFT_ROOT) {
171: man_unscope(man, n);
172: return;
173: } else {
174: n = n->parent;
175: continue;
176: }
177: }
178: if (tok != MAN_SH && (n->tok == MAN_SH ||
179: (tok != MAN_SS && (n->tok == MAN_SS ||
180: man_macros[n->tok].fp == blk_exp))))
1.53 schwarze 181: return;
1.66 schwarze 182: man_unscope(man, n);
183: n = man->last;
1.1 kristaps 184: }
1.6 schwarze 185: }
186:
1.1 kristaps 187:
1.12 schwarze 188: /*
189: * Close out a generic explicit macro.
190: */
1.53 schwarze 191: void
1.7 schwarze 192: blk_close(MACRO_PROT_ARGS)
193: {
1.64 schwarze 194: int ntok;
195: const struct roff_node *nn;
1.55 schwarze 196: char *p;
197: int nrew, target;
1.7 schwarze 198:
1.55 schwarze 199: nrew = 1;
1.7 schwarze 200: switch (tok) {
1.45 schwarze 201: case MAN_RE:
1.7 schwarze 202: ntok = MAN_RS;
1.55 schwarze 203: if ( ! man_args(man, line, pos, buf, &p))
204: break;
205: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 206: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.55 schwarze 207: nrew++;
208: target = strtol(p, &p, 10);
209: if (*p != '\0')
210: mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
211: line, p - buf, "RE ... %s", p);
212: if (target == 0)
213: target = 1;
214: nrew -= target;
215: if (nrew < 1) {
216: mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse,
217: line, ppos, "RE %d", target);
218: return;
219: }
1.39 schwarze 220: break;
1.45 schwarze 221: case MAN_UE:
1.39 schwarze 222: ntok = MAN_UR;
1.7 schwarze 223: break;
224: default:
225: abort();
226: }
227:
1.38 schwarze 228: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 229: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.7 schwarze 230: break;
231:
1.53 schwarze 232: if (nn == NULL) {
1.47 schwarze 233: mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
234: line, ppos, man_macronames[tok]);
1.66 schwarze 235: rew_scope(man, MAN_PP);
1.57 schwarze 236: } else {
237: line = man->last->line;
238: ppos = man->last->pos;
239: ntok = man->last->tok;
1.46 schwarze 240: man_unscope(man, nn);
1.57 schwarze 241:
242: /* Move a trailing paragraph behind the block. */
243:
244: if (ntok == MAN_LP || ntok == MAN_PP || ntok == MAN_P) {
245: *pos = strlen(buf);
246: blk_imp(man, ntok, line, ppos, pos, buf);
247: }
248: }
1.7 schwarze 249: }
250:
1.53 schwarze 251: void
1.12 schwarze 252: blk_exp(MACRO_PROT_ARGS)
253: {
1.64 schwarze 254: struct roff_node *head;
1.60 schwarze 255: char *p;
1.29 schwarze 256: int la;
1.12 schwarze 257:
1.66 schwarze 258: rew_scope(man, tok);
1.70 schwarze 259: roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 260: head = roff_head_alloc(man, line, ppos, tok);
1.12 schwarze 261:
1.60 schwarze 262: la = *pos;
263: if (man_args(man, line, pos, buf, &p))
1.69 schwarze 264: roff_word_alloc(man, line, la, p);
1.12 schwarze 265:
1.60 schwarze 266: if (buf[*pos] != '\0')
267: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
268: man->parse, line, *pos, "%s ... %s",
269: man_macronames[tok], buf + *pos);
1.36 schwarze 270:
1.60 schwarze 271: man_unscope(man, head);
1.68 schwarze 272: roff_body_alloc(man, line, ppos, tok);
1.12 schwarze 273: }
274:
1.6 schwarze 275: /*
1.63 schwarze 276: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
277: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.6 schwarze 278: * scopes, such as `SH' closing out an `SS', are defined in the rew
279: * routines.
280: */
1.53 schwarze 281: void
1.6 schwarze 282: blk_imp(MACRO_PROT_ARGS)
283: {
1.29 schwarze 284: int la;
1.6 schwarze 285: char *p;
1.64 schwarze 286: struct roff_node *n;
1.6 schwarze 287:
1.66 schwarze 288: rew_scope(man, tok);
1.70 schwarze 289: n = roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 290: if (n->tok == MAN_SH || n->tok == MAN_SS)
291: man->flags &= ~MAN_LITERAL;
292: n = roff_head_alloc(man, line, ppos, tok);
1.7 schwarze 293:
1.6 schwarze 294: /* Add line arguments. */
1.1 kristaps 295:
1.6 schwarze 296: for (;;) {
297: la = *pos;
1.38 schwarze 298: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 299: break;
1.69 schwarze 300: roff_word_alloc(man, line, la, p);
1.1 kristaps 301: }
302:
1.61 schwarze 303: /*
304: * For macros having optional next-line scope,
305: * keep the head open if there were no arguments.
306: * For `TP', always keep the head open.
307: */
1.6 schwarze 308:
1.61 schwarze 309: if (man_macros[tok].flags & MAN_SCOPED &&
310: (tok == MAN_TP || n == man->last)) {
311: man->flags |= MAN_BLINE;
312: return;
1.7 schwarze 313: }
1.61 schwarze 314:
315: /* Close out the head and open the body. */
316:
1.65 schwarze 317: man_unscope(man, n);
1.68 schwarze 318: roff_body_alloc(man, line, ppos, tok);
1.1 kristaps 319: }
320:
1.53 schwarze 321: void
1.6 schwarze 322: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 323: {
1.29 schwarze 324: int la;
1.6 schwarze 325: char *p;
1.64 schwarze 326: struct roff_node *n;
1.1 kristaps 327:
1.70 schwarze 328: roff_elem_alloc(man, line, ppos, tok);
1.38 schwarze 329: n = man->last;
1.1 kristaps 330:
1.6 schwarze 331: for (;;) {
1.58 schwarze 332: if (buf[*pos] != '\0' && (tok == MAN_br ||
333: tok == MAN_fi || tok == MAN_nf)) {
334: mandoc_vmsg(MANDOCERR_ARG_SKIP,
335: man->parse, line, *pos, "%s %s",
1.59 schwarze 336: man_macronames[tok], buf + *pos);
337: break;
338: }
339: if (buf[*pos] != '\0' && man->last != n &&
340: (tok == MAN_PD || tok == MAN_ft || tok == MAN_sp)) {
341: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
342: man->parse, line, *pos, "%s ... %s",
1.58 schwarze 343: man_macronames[tok], buf + *pos);
344: break;
345: }
1.6 schwarze 346: la = *pos;
1.38 schwarze 347: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 348: break;
1.52 schwarze 349: if (man_macros[tok].flags & MAN_JOIN &&
1.63 schwarze 350: man->last->type == ROFFT_TEXT)
1.69 schwarze 351: roff_word_append(man, p);
1.53 schwarze 352: else
1.69 schwarze 353: roff_word_alloc(man, line, la, p);
1.6 schwarze 354: }
1.41 schwarze 355:
356: /*
357: * Append MAN_EOS in case the last snipped argument
358: * ends with a dot, e.g. `.IR syslog (3).'
359: */
360:
361: if (n != man->last &&
1.43 schwarze 362: mandoc_eos(man->last->string, strlen(man->last->string)))
1.41 schwarze 363: man->last->flags |= MAN_EOS;
1.1 kristaps 364:
1.11 schwarze 365: /*
366: * If no arguments are specified and this is MAN_SCOPED (i.e.,
367: * next-line scoped), then set our mode to indicate that we're
368: * waiting for terms to load into our context.
369: */
370:
1.53 schwarze 371: if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
372: assert( ! (man_macros[tok].flags & MAN_NSCOPED));
1.38 schwarze 373: man->flags |= MAN_ELINE;
1.53 schwarze 374: return;
1.11 schwarze 375: }
1.31 schwarze 376:
1.63 schwarze 377: assert(man->last->type != ROFFT_ROOT);
1.67 schwarze 378: man->next = ROFF_NEXT_SIBLING;
1.45 schwarze 379:
1.6 schwarze 380: /*
1.11 schwarze 381: * Rewind our element scope. Note that when TH is pruned, we'll
382: * be back at the root, so make sure that we don't clobber as
383: * its sibling.
1.6 schwarze 384: */
1.1 kristaps 385:
1.38 schwarze 386: for ( ; man->last; man->last = man->last->parent) {
387: if (man->last == n)
1.6 schwarze 388: break;
1.63 schwarze 389: if (man->last->type == ROFFT_ROOT)
1.6 schwarze 390: break;
1.53 schwarze 391: man_valid_post(man);
1.6 schwarze 392: }
1.1 kristaps 393:
1.38 schwarze 394: assert(man->last);
1.1 kristaps 395:
396: /*
1.45 schwarze 397: * Same here regarding whether we're back at the root.
1.1 kristaps 398: */
399:
1.63 schwarze 400: if (man->last->type != ROFFT_ROOT)
1.53 schwarze 401: man_valid_post(man);
1.6 schwarze 402: }
1.1 kristaps 403:
1.53 schwarze 404: void
1.71 schwarze 405: man_endparse(struct roff_man *man)
1.6 schwarze 406: {
1.1 kristaps 407:
1.53 schwarze 408: man_unscope(man, man->first);
1.6 schwarze 409: }
1.1 kristaps 410:
1.29 schwarze 411: static int
1.67 schwarze 412: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 413: {
414: char *start;
415:
416: assert(*pos);
417: *v = start = buf + *pos;
418: assert(' ' != *start);
419:
420: if ('\0' == *start)
421: return(0);
422:
1.38 schwarze 423: *v = mandoc_getarg(man->parse, v, line, pos);
1.29 schwarze 424: return(1);
425: }
![[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