Annotation of mandoc/man_macro.c, Revision 1.146
1.146 ! schwarze 1: /* $Id: man_macro.c,v 1.145 2020/09/09 17:01:10 schwarze Exp $ */
1.1 kristaps 2: /*
1.146 ! schwarze 3: * Copyright (c) 2012-2015,2017-2020,2022 Ingo Schwarze <schwarze@openbsd.org>
1.65 schwarze 4: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.79 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.14 kristaps 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.101 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.14 kristaps 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.101 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.14 kristaps 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.30 kristaps 19: #include "config.h"
1.88 schwarze 20:
21: #include <sys/types.h>
1.30 kristaps 22:
1.1 kristaps 23: #include <assert.h>
24: #include <ctype.h>
1.134 schwarze 25: #include <stdio.h>
1.1 kristaps 26: #include <stdlib.h>
27: #include <string.h>
28:
1.101 schwarze 29: #include "mandoc.h"
30: #include "roff.h"
1.58 kristaps 31: #include "man.h"
1.57 kristaps 32: #include "libmandoc.h"
1.106 schwarze 33: #include "roff_int.h"
1.1 kristaps 34: #include "libman.h"
35:
1.91 schwarze 36: static void blk_close(MACRO_PROT_ARGS);
37: static void blk_exp(MACRO_PROT_ARGS);
38: static void blk_imp(MACRO_PROT_ARGS);
39: static void in_line_eoln(MACRO_PROT_ARGS);
1.105 schwarze 40: static int man_args(struct roff_man *, int,
1.60 kristaps 41: int *, char *, char **);
1.116 schwarze 42: static void rew_scope(struct roff_man *, enum roff_tok);
1.19 kristaps 43:
1.127 schwarze 44: static const struct man_macro man_macros[MAN_MAX - MAN_TH] = {
1.133 schwarze 45: { in_line_eoln, MAN_XSCOPE }, /* TH */
46: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SH */
47: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SS */
48: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TP */
49: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TQ */
50: { blk_imp, MAN_XSCOPE }, /* LP */
51: { blk_imp, MAN_XSCOPE }, /* PP */
52: { blk_imp, MAN_XSCOPE }, /* P */
53: { blk_imp, MAN_XSCOPE }, /* IP */
54: { blk_imp, MAN_XSCOPE }, /* HP */
55: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SM */
56: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SB */
1.19 kristaps 57: { in_line_eoln, 0 }, /* BI */
58: { in_line_eoln, 0 }, /* IB */
59: { in_line_eoln, 0 }, /* BR */
60: { in_line_eoln, 0 }, /* RB */
1.133 schwarze 61: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* R */
62: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* B */
63: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* I */
1.19 kristaps 64: { in_line_eoln, 0 }, /* IR */
65: { in_line_eoln, 0 }, /* RI */
1.133 schwarze 66: { blk_close, MAN_XSCOPE }, /* RE */
67: { blk_exp, MAN_XSCOPE }, /* RS */
1.23 kristaps 68: { in_line_eoln, 0 }, /* DT */
1.28 kristaps 69: { in_line_eoln, 0 }, /* UC */
1.100 schwarze 70: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.45 joerg 71: { in_line_eoln, 0 }, /* AT */
1.122 schwarze 72: { in_line_eoln, MAN_NSCOPED }, /* in */
1.133 schwarze 73: { blk_imp, MAN_XSCOPE }, /* SY */
74: { blk_close, MAN_XSCOPE }, /* YS */
1.71 kristaps 75: { in_line_eoln, 0 }, /* OP */
1.133 schwarze 76: { in_line_eoln, MAN_XSCOPE }, /* EX */
77: { in_line_eoln, MAN_XSCOPE }, /* EE */
78: { blk_exp, MAN_XSCOPE }, /* UR */
79: { blk_close, MAN_XSCOPE }, /* UE */
80: { blk_exp, MAN_XSCOPE }, /* MT */
81: { blk_close, MAN_XSCOPE }, /* ME */
1.19 kristaps 82: };
1.1 kristaps 83:
84:
1.127 schwarze 85: const struct man_macro *
86: man_macro(enum roff_tok tok)
87: {
88: assert(tok >= MAN_TH && tok <= MAN_MAX);
89: return man_macros + (tok - MAN_TH);
90: }
91:
1.91 schwarze 92: void
1.105 schwarze 93: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1 kristaps 94: {
1.102 schwarze 95: struct roff_node *n;
1.1 kristaps 96:
1.83 schwarze 97: to = to->parent;
98: n = man->last;
99: while (n != to) {
1.87 schwarze 100:
101: /* Reached the end of the document? */
102:
1.115 schwarze 103: if (to == NULL && ! (n->flags & NODE_VALID)) {
1.87 schwarze 104: if (man->flags & (MAN_BLINE | MAN_ELINE) &&
1.133 schwarze 105: man_macro(n->tok)->flags &
106: (MAN_BSCOPED | MAN_NSCOPED)) {
1.135 schwarze 107: mandoc_msg(MANDOCERR_BLK_LINE,
108: n->line, n->pos,
1.116 schwarze 109: "EOF breaks %s", roff_name[n->tok]);
1.145 schwarze 110: if (man->flags & MAN_ELINE) {
1.146 ! schwarze 111: if (n->parent->type == ROFFT_ROOT ||
! 112: (man_macro(n->parent->tok)->flags &
1.145 schwarze 113: MAN_ESCOPED) == 0)
114: man->flags &= ~MAN_ELINE;
115: } else {
1.101 schwarze 116: assert(n->type == ROFFT_HEAD);
1.87 schwarze 117: n = n->parent;
118: man->flags &= ~MAN_BLINE;
119: }
120: man->last = n;
121: n = n->parent;
1.106 schwarze 122: roff_node_delete(man, man->last);
1.87 schwarze 123: continue;
124: }
1.101 schwarze 125: if (n->type == ROFFT_BLOCK &&
1.127 schwarze 126: man_macro(n->tok)->fp == blk_exp)
1.87 schwarze 127: mandoc_msg(MANDOCERR_BLK_NOEND,
1.135 schwarze 128: n->line, n->pos, "%s",
1.116 schwarze 129: roff_name[n->tok]);
1.87 schwarze 130: }
131:
1.55 kristaps 132: /*
1.83 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.55 kristaps 137: */
1.89 schwarze 138:
1.83 schwarze 139: man->last = n;
140: n = n->parent;
1.115 schwarze 141: man->last->flags |= NODE_VALID;
1.19 kristaps 142: }
1.89 schwarze 143:
144: /*
145: * If we ended up at the parent of the node we were
146: * supposed to rewind to, that means the target node
147: * got deleted, so add the next node we parse as a child
148: * of the parent instead of as a sibling of the target.
149: */
150:
151: man->next = (man->last == to) ?
1.105 schwarze 152: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.19 kristaps 153: }
1.1 kristaps 154:
1.19 kristaps 155: /*
156: * Rewinding entails ascending the parse tree until a coherent point,
157: * for example, the `SH' macro will close out any intervening `SS'
158: * scopes. When a scope is closed, it must be validated and actioned.
159: */
1.91 schwarze 160: static void
1.116 schwarze 161: rew_scope(struct roff_man *man, enum roff_tok tok)
1.19 kristaps 162: {
1.102 schwarze 163: struct roff_node *n;
1.7 kristaps 164:
1.104 schwarze 165: /* Preserve empty paragraphs before RS. */
166:
167: n = man->last;
1.114 schwarze 168: if (tok == MAN_RS && n->child == NULL &&
1.104 schwarze 169: (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
170: return;
171:
172: for (;;) {
173: if (n->type == ROFFT_ROOT)
174: return;
1.115 schwarze 175: if (n->flags & NODE_VALID) {
1.104 schwarze 176: n = n->parent;
177: continue;
178: }
179: if (n->type != ROFFT_BLOCK) {
180: if (n->parent->type == ROFFT_ROOT) {
181: man_unscope(man, n);
182: return;
183: } else {
184: n = n->parent;
185: continue;
186: }
187: }
188: if (tok != MAN_SH && (n->tok == MAN_SH ||
189: (tok != MAN_SS && (n->tok == MAN_SS ||
1.127 schwarze 190: man_macro(n->tok)->fp == blk_exp))))
1.91 schwarze 191: return;
1.104 schwarze 192: man_unscope(man, n);
193: n = man->last;
1.6 kristaps 194: }
1.19 kristaps 195: }
196:
1.6 kristaps 197:
1.36 kristaps 198: /*
199: * Close out a generic explicit macro.
200: */
1.91 schwarze 201: void
1.21 kristaps 202: blk_close(MACRO_PROT_ARGS)
203: {
1.124 schwarze 204: enum roff_tok ctok, ntok;
1.102 schwarze 205: const struct roff_node *nn;
1.137 schwarze 206: char *p, *ep;
207: int cline, cpos, la, nrew, target;
1.21 kristaps 208:
1.93 schwarze 209: nrew = 1;
1.21 kristaps 210: switch (tok) {
1.82 schwarze 211: case MAN_RE:
1.21 kristaps 212: ntok = MAN_RS;
1.137 schwarze 213: la = *pos;
1.93 schwarze 214: if ( ! man_args(man, line, pos, buf, &p))
215: break;
216: for (nn = man->last->parent; nn; nn = nn->parent)
1.101 schwarze 217: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.93 schwarze 218: nrew++;
1.137 schwarze 219: target = strtol(p, &ep, 10);
220: if (*ep != '\0')
1.135 schwarze 221: mandoc_msg(MANDOCERR_ARG_EXCESS, line,
1.137 schwarze 222: la + (buf[la] == '"') + (int)(ep - p),
223: "RE ... %s", ep);
224: free(p);
1.93 schwarze 225: if (target == 0)
226: target = 1;
227: nrew -= target;
228: if (nrew < 1) {
1.135 schwarze 229: mandoc_msg(MANDOCERR_RE_NOTOPEN,
1.93 schwarze 230: line, ppos, "RE %d", target);
231: return;
232: }
1.128 schwarze 233: break;
234: case MAN_YS:
235: ntok = MAN_SY;
1.76 schwarze 236: break;
1.82 schwarze 237: case MAN_UE:
1.76 schwarze 238: ntok = MAN_UR;
1.123 schwarze 239: break;
240: case MAN_ME:
241: ntok = MAN_MT;
1.21 kristaps 242: break;
243: default:
244: abort();
245: }
246:
1.75 schwarze 247: for (nn = man->last->parent; nn; nn = nn->parent)
1.101 schwarze 248: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.21 kristaps 249: break;
250:
1.91 schwarze 251: if (nn == NULL) {
1.135 schwarze 252: mandoc_msg(MANDOCERR_BLK_NOTOPEN,
253: line, ppos, "%s", roff_name[tok]);
1.104 schwarze 254: rew_scope(man, MAN_PP);
1.131 schwarze 255: if (tok == MAN_RE) {
256: roff_elem_alloc(man, line, ppos, ROFF_br);
257: man->last->flags |= NODE_LINE |
258: NODE_VALID | NODE_ENDED;
259: man->next = ROFF_NEXT_SIBLING;
260: }
1.124 schwarze 261: return;
262: }
263:
264: cline = man->last->line;
265: cpos = man->last->pos;
266: ctok = man->last->tok;
267: man_unscope(man, nn);
268:
269: if (tok == MAN_RE && nn->head->aux > 0)
270: roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
271:
272: /* Trailing text. */
273:
274: if (buf[*pos] != '\0') {
275: roff_word_alloc(man, line, ppos, buf + *pos);
276: man->last->flags |= NODE_DELIMC;
1.130 schwarze 277: if (mandoc_eos(man->last->string, strlen(man->last->string)))
278: man->last->flags |= NODE_EOS;
1.124 schwarze 279: }
280:
281: /* Move a trailing paragraph behind the block. */
282:
283: if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
284: *pos = strlen(buf);
1.125 schwarze 285: blk_imp(man, ctok, cline, cpos, pos, buf);
1.129 schwarze 286: }
287:
288: /* Synopsis blocks need an explicit end marker for spacing. */
289:
290: if (tok == MAN_YS && man->last == nn) {
291: roff_elem_alloc(man, line, ppos, tok);
292: man_unscope(man, man->last);
1.95 schwarze 293: }
1.21 kristaps 294: }
295:
1.91 schwarze 296: void
1.35 kristaps 297: blk_exp(MACRO_PROT_ARGS)
298: {
1.102 schwarze 299: struct roff_node *head;
1.98 schwarze 300: char *p;
1.59 kristaps 301: int la;
1.35 kristaps 302:
1.144 schwarze 303: if (tok == MAN_RS) {
1.132 schwarze 304: rew_scope(man, tok);
1.144 schwarze 305: man->flags |= ROFF_NONOFILL;
306: }
1.108 schwarze 307: roff_block_alloc(man, line, ppos, tok);
1.106 schwarze 308: head = roff_head_alloc(man, line, ppos, tok);
1.35 kristaps 309:
1.98 schwarze 310: la = *pos;
1.121 schwarze 311: if (man_args(man, line, pos, buf, &p)) {
1.107 schwarze 312: roff_word_alloc(man, line, la, p);
1.121 schwarze 313: if (tok == MAN_RS) {
314: if (roff_getreg(man->roff, "an-margin") == 0)
315: roff_setreg(man->roff, "an-margin",
316: 7 * 24, '=');
317: if ((head->aux = strtod(p, NULL) * 24.0) > 0)
318: roff_setreg(man->roff, "an-margin",
319: head->aux, '+');
320: }
1.137 schwarze 321: free(p);
1.121 schwarze 322: }
1.35 kristaps 323:
1.98 schwarze 324: if (buf[*pos] != '\0')
1.135 schwarze 325: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
326: "%s ... %s", roff_name[tok], buf + *pos);
1.73 schwarze 327:
1.98 schwarze 328: man_unscope(man, head);
1.106 schwarze 329: roff_body_alloc(man, line, ppos, tok);
1.144 schwarze 330: man->flags &= ~ROFF_NONOFILL;
1.35 kristaps 331: }
332:
1.19 kristaps 333: /*
1.101 schwarze 334: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
335: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.19 kristaps 336: * scopes, such as `SH' closing out an `SS', are defined in the rew
337: * routines.
338: */
1.91 schwarze 339: void
1.19 kristaps 340: blk_imp(MACRO_PROT_ARGS)
341: {
1.59 kristaps 342: int la;
1.19 kristaps 343: char *p;
1.102 schwarze 344: struct roff_node *n;
1.19 kristaps 345:
1.104 schwarze 346: rew_scope(man, tok);
1.143 schwarze 347: man->flags |= ROFF_NONOFILL;
1.140 schwarze 348: if (tok == MAN_SH || tok == MAN_SS)
349: man->flags &= ~ROFF_NOFILL;
350: roff_block_alloc(man, line, ppos, tok);
1.106 schwarze 351: n = roff_head_alloc(man, line, ppos, tok);
1.25 kristaps 352:
1.19 kristaps 353: /* Add line arguments. */
1.3 kristaps 354:
1.19 kristaps 355: for (;;) {
356: la = *pos;
1.75 schwarze 357: if ( ! man_args(man, line, pos, buf, &p))
1.19 kristaps 358: break;
1.107 schwarze 359: roff_word_alloc(man, line, la, p);
1.137 schwarze 360: free(p);
1.6 kristaps 361: }
362:
1.99 schwarze 363: /*
364: * For macros having optional next-line scope,
365: * keep the head open if there were no arguments.
1.133 schwarze 366: * For `TP' and `TQ', always keep the head open.
1.99 schwarze 367: */
1.19 kristaps 368:
1.133 schwarze 369: if (man_macro(tok)->flags & MAN_BSCOPED &&
1.126 schwarze 370: (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
1.99 schwarze 371: man->flags |= MAN_BLINE;
372: return;
1.27 kristaps 373: }
1.99 schwarze 374:
375: /* Close out the head and open the body. */
376:
1.103 schwarze 377: man_unscope(man, n);
1.106 schwarze 378: roff_body_alloc(man, line, ppos, tok);
1.143 schwarze 379: man->flags &= ~ROFF_NONOFILL;
1.4 kristaps 380: }
381:
1.91 schwarze 382: void
1.19 kristaps 383: in_line_eoln(MACRO_PROT_ARGS)
1.3 kristaps 384: {
1.59 kristaps 385: int la;
1.19 kristaps 386: char *p;
1.102 schwarze 387: struct roff_node *n;
1.3 kristaps 388:
1.108 schwarze 389: roff_elem_alloc(man, line, ppos, tok);
1.75 schwarze 390: n = man->last;
1.141 schwarze 391:
392: if (tok == MAN_EX)
393: man->flags |= ROFF_NOFILL;
394: else if (tok == MAN_EE)
395: man->flags &= ~ROFF_NOFILL;
1.3 kristaps 396:
1.19 kristaps 397: for (;;) {
1.120 schwarze 398: if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
1.135 schwarze 399: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
400: "%s ... %s", roff_name[tok], buf + *pos);
1.96 schwarze 401: break;
402: }
1.19 kristaps 403: la = *pos;
1.75 schwarze 404: if ( ! man_args(man, line, pos, buf, &p))
1.19 kristaps 405: break;
1.127 schwarze 406: if (man_macro(tok)->flags & MAN_JOIN &&
1.101 schwarze 407: man->last->type == ROFFT_TEXT)
1.107 schwarze 408: roff_word_append(man, p);
1.91 schwarze 409: else
1.107 schwarze 410: roff_word_alloc(man, line, la, p);
1.137 schwarze 411: free(p);
1.19 kristaps 412: }
1.78 schwarze 413:
414: /*
1.115 schwarze 415: * Append NODE_EOS in case the last snipped argument
1.78 schwarze 416: * ends with a dot, e.g. `.IR syslog (3).'
417: */
418:
419: if (n != man->last &&
1.80 schwarze 420: mandoc_eos(man->last->string, strlen(man->last->string)))
1.115 schwarze 421: man->last->flags |= NODE_EOS;
1.3 kristaps 422:
1.31 kristaps 423: /*
1.133 schwarze 424: * If no arguments are specified and this is MAN_ESCOPED (i.e.,
1.31 kristaps 425: * next-line scoped), then set our mode to indicate that we're
426: * waiting for terms to load into our context.
427: */
428:
1.133 schwarze 429: if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) {
1.75 schwarze 430: man->flags |= MAN_ELINE;
1.91 schwarze 431: return;
1.31 kristaps 432: }
1.64 kristaps 433:
1.101 schwarze 434: assert(man->last->type != ROFFT_ROOT);
1.105 schwarze 435: man->next = ROFF_NEXT_SIBLING;
1.82 schwarze 436:
1.113 schwarze 437: /* Rewind our element scope. */
1.3 kristaps 438:
1.75 schwarze 439: for ( ; man->last; man->last = man->last->parent) {
1.142 schwarze 440: man->last->flags |= NODE_VALID;
1.75 schwarze 441: if (man->last == n)
1.19 kristaps 442: break;
443: }
1.133 schwarze 444:
445: /* Rewind next-line scoped ancestors, if any. */
446:
447: if (man_macro(tok)->flags & MAN_ESCOPED)
448: man_descope(man, line, ppos, NULL);
1.19 kristaps 449: }
1.3 kristaps 450:
1.91 schwarze 451: void
1.109 schwarze 452: man_endparse(struct roff_man *man)
1.19 kristaps 453: {
1.138 schwarze 454: man_unscope(man, man->meta.first);
1.19 kristaps 455: }
1.3 kristaps 456:
1.60 kristaps 457: static int
1.105 schwarze 458: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.60 kristaps 459: {
460: char *start;
461:
462: assert(*pos);
463: *v = start = buf + *pos;
464: assert(' ' != *start);
465:
466: if ('\0' == *start)
1.112 schwarze 467: return 0;
1.60 kristaps 468:
1.137 schwarze 469: *v = roff_getarg(man->roff, v, line, pos);
1.112 schwarze 470: return 1;
1.60 kristaps 471: }
CVSweb