Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.95
1.95 ! schwarze 1: /* $OpenBSD: man_macro.c,v 1.94 2018/08/18 20:41:50 schwarze Exp $ */
1.1 kristaps 2: /*
1.29 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.86 schwarze 4: * Copyright (c) 2012-2015, 2017, 2018 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.78 schwarze 39: static void rew_scope(struct roff_man *, enum roff_tok);
1.6 schwarze 40:
1.89 schwarze 41: static const struct man_macro man_macros[MAN_MAX - MAN_TH] = {
1.95 ! schwarze 42: { in_line_eoln, MAN_XSCOPE }, /* TH */
! 43: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SH */
! 44: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SS */
! 45: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TP */
! 46: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TQ */
! 47: { blk_imp, MAN_XSCOPE }, /* LP */
! 48: { blk_imp, MAN_XSCOPE }, /* PP */
! 49: { blk_imp, MAN_XSCOPE }, /* P */
! 50: { blk_imp, MAN_XSCOPE }, /* IP */
! 51: { blk_imp, MAN_XSCOPE }, /* HP */
! 52: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SM */
! 53: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | 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.95 ! schwarze 58: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* R */
! 59: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* B */
! 60: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* I */
1.6 schwarze 61: { in_line_eoln, 0 }, /* IR */
62: { in_line_eoln, 0 }, /* RI */
1.72 schwarze 63: { in_line_eoln, MAN_NSCOPED }, /* nf */
64: { in_line_eoln, MAN_NSCOPED }, /* fi */
1.95 ! schwarze 65: { blk_close, MAN_XSCOPE }, /* RE */
! 66: { blk_exp, MAN_XSCOPE }, /* RS */
1.7 schwarze 67: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 68: { in_line_eoln, 0 }, /* UC */
1.62 schwarze 69: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.18 schwarze 70: { in_line_eoln, 0 }, /* AT */
1.84 schwarze 71: { in_line_eoln, MAN_NSCOPED }, /* in */
1.95 ! schwarze 72: { blk_imp, MAN_XSCOPE }, /* SY */
! 73: { blk_close, MAN_XSCOPE }, /* YS */
1.34 schwarze 74: { in_line_eoln, 0 }, /* OP */
1.95 ! schwarze 75: { in_line_eoln, MAN_XSCOPE }, /* EX */
! 76: { in_line_eoln, MAN_XSCOPE }, /* EE */
! 77: { blk_exp, MAN_XSCOPE }, /* UR */
! 78: { blk_close, MAN_XSCOPE }, /* UE */
! 79: { blk_exp, MAN_XSCOPE }, /* MT */
! 80: { blk_close, MAN_XSCOPE }, /* ME */
1.6 schwarze 81: };
1.1 kristaps 82:
83:
1.89 schwarze 84: const struct man_macro *
85: man_macro(enum roff_tok tok)
86: {
87: assert(tok >= MAN_TH && tok <= MAN_MAX);
88: return man_macros + (tok - MAN_TH);
89: }
90:
1.53 schwarze 91: void
1.67 schwarze 92: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1 kristaps 93: {
1.64 schwarze 94: struct roff_node *n;
1.1 kristaps 95:
1.46 schwarze 96: to = to->parent;
97: n = man->last;
98: while (n != to) {
1.50 schwarze 99:
100: /* Reached the end of the document? */
101:
1.77 schwarze 102: if (to == NULL && ! (n->flags & NODE_VALID)) {
1.50 schwarze 103: if (man->flags & (MAN_BLINE | MAN_ELINE) &&
1.95 ! schwarze 104: man_macro(n->tok)->flags &
! 105: (MAN_BSCOPED | MAN_NSCOPED)) {
1.50 schwarze 106: mandoc_vmsg(MANDOCERR_BLK_LINE,
107: man->parse, n->line, n->pos,
1.78 schwarze 108: "EOF breaks %s", roff_name[n->tok]);
1.50 schwarze 109: if (man->flags & MAN_ELINE)
110: man->flags &= ~MAN_ELINE;
111: else {
1.63 schwarze 112: assert(n->type == ROFFT_HEAD);
1.50 schwarze 113: n = n->parent;
114: man->flags &= ~MAN_BLINE;
115: }
116: man->last = n;
117: n = n->parent;
1.68 schwarze 118: roff_node_delete(man, man->last);
1.50 schwarze 119: continue;
120: }
1.63 schwarze 121: if (n->type == ROFFT_BLOCK &&
1.89 schwarze 122: man_macro(n->tok)->fp == blk_exp)
1.50 schwarze 123: mandoc_msg(MANDOCERR_BLK_NOEND,
124: man->parse, n->line, n->pos,
1.78 schwarze 125: roff_name[n->tok]);
1.50 schwarze 126: }
127:
1.27 schwarze 128: /*
1.46 schwarze 129: * We might delete the man->last node
130: * in the post-validation phase.
131: * Save a pointer to the parent such that
132: * we know where to continue the iteration.
1.27 schwarze 133: */
1.51 schwarze 134:
1.46 schwarze 135: man->last = n;
136: n = n->parent;
1.77 schwarze 137: man->last->flags |= NODE_VALID;
1.6 schwarze 138: }
1.51 schwarze 139:
140: /*
141: * If we ended up at the parent of the node we were
142: * supposed to rewind to, that means the target node
143: * got deleted, so add the next node we parse as a child
144: * of the parent instead of as a sibling of the target.
145: */
146:
147: man->next = (man->last == to) ?
1.67 schwarze 148: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.6 schwarze 149: }
1.1 kristaps 150:
1.6 schwarze 151: /*
152: * Rewinding entails ascending the parse tree until a coherent point,
153: * for example, the `SH' macro will close out any intervening `SS'
154: * scopes. When a scope is closed, it must be validated and actioned.
155: */
1.53 schwarze 156: static void
1.78 schwarze 157: rew_scope(struct roff_man *man, enum roff_tok tok)
1.6 schwarze 158: {
1.64 schwarze 159: struct roff_node *n;
1.1 kristaps 160:
1.66 schwarze 161: /* Preserve empty paragraphs before RS. */
162:
163: n = man->last;
1.76 schwarze 164: if (tok == MAN_RS && n->child == NULL &&
1.66 schwarze 165: (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
166: return;
167:
168: for (;;) {
169: if (n->type == ROFFT_ROOT)
170: return;
1.77 schwarze 171: if (n->flags & NODE_VALID) {
1.66 schwarze 172: n = n->parent;
173: continue;
174: }
175: if (n->type != ROFFT_BLOCK) {
176: if (n->parent->type == ROFFT_ROOT) {
177: man_unscope(man, n);
178: return;
179: } else {
180: n = n->parent;
181: continue;
182: }
183: }
184: if (tok != MAN_SH && (n->tok == MAN_SH ||
185: (tok != MAN_SS && (n->tok == MAN_SS ||
1.89 schwarze 186: man_macro(n->tok)->fp == blk_exp))))
1.53 schwarze 187: return;
1.66 schwarze 188: man_unscope(man, n);
189: n = man->last;
1.1 kristaps 190: }
1.6 schwarze 191: }
192:
1.1 kristaps 193:
1.12 schwarze 194: /*
195: * Close out a generic explicit macro.
196: */
1.53 schwarze 197: void
1.7 schwarze 198: blk_close(MACRO_PROT_ARGS)
199: {
1.86 schwarze 200: enum roff_tok ctok, ntok;
1.64 schwarze 201: const struct roff_node *nn;
1.55 schwarze 202: char *p;
1.86 schwarze 203: int cline, cpos, nrew, target;
1.7 schwarze 204:
1.55 schwarze 205: nrew = 1;
1.7 schwarze 206: switch (tok) {
1.45 schwarze 207: case MAN_RE:
1.7 schwarze 208: ntok = MAN_RS;
1.55 schwarze 209: if ( ! man_args(man, line, pos, buf, &p))
210: break;
211: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 212: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.55 schwarze 213: nrew++;
214: target = strtol(p, &p, 10);
215: if (*p != '\0')
216: mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
217: line, p - buf, "RE ... %s", p);
218: if (target == 0)
219: target = 1;
220: nrew -= target;
221: if (nrew < 1) {
222: mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse,
223: line, ppos, "RE %d", target);
224: return;
225: }
1.90 schwarze 226: break;
227: case MAN_YS:
228: ntok = MAN_SY;
1.39 schwarze 229: break;
1.45 schwarze 230: case MAN_UE:
1.39 schwarze 231: ntok = MAN_UR;
1.85 bentley 232: break;
233: case MAN_ME:
234: ntok = MAN_MT;
1.7 schwarze 235: break;
236: default:
237: abort();
238: }
239:
1.38 schwarze 240: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 241: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.7 schwarze 242: break;
243:
1.53 schwarze 244: if (nn == NULL) {
1.47 schwarze 245: mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
1.78 schwarze 246: line, ppos, roff_name[tok]);
1.66 schwarze 247: rew_scope(man, MAN_PP);
1.93 schwarze 248: if (tok == MAN_RE) {
249: roff_elem_alloc(man, line, ppos, ROFF_br);
250: man->last->flags |= NODE_LINE |
251: NODE_VALID | NODE_ENDED;
252: man->next = ROFF_NEXT_SIBLING;
253: }
1.86 schwarze 254: return;
255: }
256:
257: cline = man->last->line;
258: cpos = man->last->pos;
259: ctok = man->last->tok;
260: man_unscope(man, nn);
261:
262: if (tok == MAN_RE && nn->head->aux > 0)
263: roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
264:
265: /* Trailing text. */
266:
267: if (buf[*pos] != '\0') {
268: roff_word_alloc(man, line, ppos, buf + *pos);
269: man->last->flags |= NODE_DELIMC;
1.92 schwarze 270: if (mandoc_eos(man->last->string, strlen(man->last->string)))
271: man->last->flags |= NODE_EOS;
1.86 schwarze 272: }
273:
274: /* Move a trailing paragraph behind the block. */
275:
276: if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
277: *pos = strlen(buf);
1.87 schwarze 278: blk_imp(man, ctok, cline, cpos, pos, buf);
1.91 schwarze 279: }
280:
281: /* Synopsis blocks need an explicit end marker for spacing. */
282:
283: if (tok == MAN_YS && man->last == nn) {
284: roff_elem_alloc(man, line, ppos, tok);
285: man_unscope(man, man->last);
1.57 schwarze 286: }
1.7 schwarze 287: }
288:
1.53 schwarze 289: void
1.12 schwarze 290: blk_exp(MACRO_PROT_ARGS)
291: {
1.64 schwarze 292: struct roff_node *head;
1.60 schwarze 293: char *p;
1.29 schwarze 294: int la;
1.12 schwarze 295:
1.94 schwarze 296: if (tok == MAN_RS)
297: rew_scope(man, tok);
1.70 schwarze 298: roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 299: head = roff_head_alloc(man, line, ppos, tok);
1.12 schwarze 300:
1.60 schwarze 301: la = *pos;
1.83 schwarze 302: if (man_args(man, line, pos, buf, &p)) {
1.69 schwarze 303: roff_word_alloc(man, line, la, p);
1.83 schwarze 304: if (tok == MAN_RS) {
305: if (roff_getreg(man->roff, "an-margin") == 0)
306: roff_setreg(man->roff, "an-margin",
307: 7 * 24, '=');
308: if ((head->aux = strtod(p, NULL) * 24.0) > 0)
309: roff_setreg(man->roff, "an-margin",
310: head->aux, '+');
311: }
312: }
1.12 schwarze 313:
1.60 schwarze 314: if (buf[*pos] != '\0')
1.78 schwarze 315: mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, line,
316: *pos, "%s ... %s", roff_name[tok], buf + *pos);
1.36 schwarze 317:
1.60 schwarze 318: man_unscope(man, head);
1.68 schwarze 319: roff_body_alloc(man, line, ppos, tok);
1.12 schwarze 320: }
321:
1.6 schwarze 322: /*
1.63 schwarze 323: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
324: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.6 schwarze 325: * scopes, such as `SH' closing out an `SS', are defined in the rew
326: * routines.
327: */
1.53 schwarze 328: void
1.6 schwarze 329: blk_imp(MACRO_PROT_ARGS)
330: {
1.29 schwarze 331: int la;
1.6 schwarze 332: char *p;
1.64 schwarze 333: struct roff_node *n;
1.6 schwarze 334:
1.66 schwarze 335: rew_scope(man, tok);
1.70 schwarze 336: n = roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 337: if (n->tok == MAN_SH || n->tok == MAN_SS)
338: man->flags &= ~MAN_LITERAL;
339: n = roff_head_alloc(man, line, ppos, tok);
1.7 schwarze 340:
1.6 schwarze 341: /* Add line arguments. */
1.1 kristaps 342:
1.6 schwarze 343: for (;;) {
344: la = *pos;
1.38 schwarze 345: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 346: break;
1.69 schwarze 347: roff_word_alloc(man, line, la, p);
1.1 kristaps 348: }
349:
1.61 schwarze 350: /*
351: * For macros having optional next-line scope,
352: * keep the head open if there were no arguments.
1.95 ! schwarze 353: * For `TP' and `TQ', always keep the head open.
1.61 schwarze 354: */
1.6 schwarze 355:
1.95 ! schwarze 356: if (man_macro(tok)->flags & MAN_BSCOPED &&
1.88 schwarze 357: (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
1.61 schwarze 358: man->flags |= MAN_BLINE;
359: return;
1.7 schwarze 360: }
1.61 schwarze 361:
362: /* Close out the head and open the body. */
363:
1.65 schwarze 364: man_unscope(man, n);
1.68 schwarze 365: roff_body_alloc(man, line, ppos, tok);
1.1 kristaps 366: }
367:
1.53 schwarze 368: void
1.6 schwarze 369: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 370: {
1.29 schwarze 371: int la;
1.6 schwarze 372: char *p;
1.64 schwarze 373: struct roff_node *n;
1.1 kristaps 374:
1.70 schwarze 375: roff_elem_alloc(man, line, ppos, tok);
1.38 schwarze 376: n = man->last;
1.1 kristaps 377:
1.6 schwarze 378: for (;;) {
1.79 schwarze 379: if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
1.58 schwarze 380: mandoc_vmsg(MANDOCERR_ARG_SKIP,
381: man->parse, line, *pos, "%s %s",
1.78 schwarze 382: roff_name[tok], buf + *pos);
1.59 schwarze 383: break;
384: }
1.82 schwarze 385: if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
1.59 schwarze 386: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
387: man->parse, line, *pos, "%s ... %s",
1.78 schwarze 388: roff_name[tok], buf + *pos);
1.58 schwarze 389: break;
390: }
1.6 schwarze 391: la = *pos;
1.38 schwarze 392: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 393: break;
1.89 schwarze 394: if (man_macro(tok)->flags & MAN_JOIN &&
1.63 schwarze 395: man->last->type == ROFFT_TEXT)
1.69 schwarze 396: roff_word_append(man, p);
1.53 schwarze 397: else
1.69 schwarze 398: roff_word_alloc(man, line, la, p);
1.6 schwarze 399: }
1.41 schwarze 400:
401: /*
1.77 schwarze 402: * Append NODE_EOS in case the last snipped argument
1.41 schwarze 403: * ends with a dot, e.g. `.IR syslog (3).'
404: */
405:
406: if (n != man->last &&
1.43 schwarze 407: mandoc_eos(man->last->string, strlen(man->last->string)))
1.77 schwarze 408: man->last->flags |= NODE_EOS;
1.1 kristaps 409:
1.11 schwarze 410: /*
1.95 ! schwarze 411: * If no arguments are specified and this is MAN_ESCOPED (i.e.,
1.11 schwarze 412: * next-line scoped), then set our mode to indicate that we're
413: * waiting for terms to load into our context.
414: */
415:
1.95 ! schwarze 416: if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) {
1.38 schwarze 417: man->flags |= MAN_ELINE;
1.53 schwarze 418: return;
1.11 schwarze 419: }
1.31 schwarze 420:
1.63 schwarze 421: assert(man->last->type != ROFFT_ROOT);
1.67 schwarze 422: man->next = ROFF_NEXT_SIBLING;
1.45 schwarze 423:
1.75 schwarze 424: /* Rewind our element scope. */
1.1 kristaps 425:
1.38 schwarze 426: for ( ; man->last; man->last = man->last->parent) {
1.75 schwarze 427: man_state(man, man->last);
1.38 schwarze 428: if (man->last == n)
1.6 schwarze 429: break;
430: }
1.95 ! schwarze 431:
! 432: /* Rewind next-line scoped ancestors, if any. */
! 433:
! 434: if (man_macro(tok)->flags & MAN_ESCOPED)
! 435: man_descope(man, line, ppos, NULL);
1.6 schwarze 436: }
1.1 kristaps 437:
1.53 schwarze 438: void
1.71 schwarze 439: man_endparse(struct roff_man *man)
1.6 schwarze 440: {
1.1 kristaps 441:
1.53 schwarze 442: man_unscope(man, man->first);
1.75 schwarze 443: man->flags &= ~MAN_LITERAL;
1.6 schwarze 444: }
1.1 kristaps 445:
1.29 schwarze 446: static int
1.67 schwarze 447: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 448: {
449: char *start;
450:
451: assert(*pos);
452: *v = start = buf + *pos;
453: assert(' ' != *start);
454:
455: if ('\0' == *start)
1.74 schwarze 456: return 0;
1.29 schwarze 457:
1.38 schwarze 458: *v = mandoc_getarg(man->parse, v, line, pos);
1.74 schwarze 459: return 1;
1.29 schwarze 460: }
![[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