Annotation of mandoc/man_macro.c, Revision 1.140
1.140 ! schwarze 1: /* $Id: man_macro.c,v 1.139 2018/12/31 04:55:46 schwarze Exp $ */
1.1 kristaps 2: /*
1.65 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.124 schwarze 4: * Copyright (c) 2012-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
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.87 schwarze 110: if (man->flags & MAN_ELINE)
111: man->flags &= ~MAN_ELINE;
112: else {
1.101 schwarze 113: assert(n->type == ROFFT_HEAD);
1.87 schwarze 114: n = n->parent;
115: man->flags &= ~MAN_BLINE;
116: }
117: man->last = n;
118: n = n->parent;
1.106 schwarze 119: roff_node_delete(man, man->last);
1.87 schwarze 120: continue;
121: }
1.101 schwarze 122: if (n->type == ROFFT_BLOCK &&
1.127 schwarze 123: man_macro(n->tok)->fp == blk_exp)
1.87 schwarze 124: mandoc_msg(MANDOCERR_BLK_NOEND,
1.135 schwarze 125: n->line, n->pos, "%s",
1.116 schwarze 126: roff_name[n->tok]);
1.87 schwarze 127: }
128:
1.55 kristaps 129: /*
1.83 schwarze 130: * We might delete the man->last node
131: * in the post-validation phase.
132: * Save a pointer to the parent such that
133: * we know where to continue the iteration.
1.55 kristaps 134: */
1.89 schwarze 135:
1.83 schwarze 136: man->last = n;
137: n = n->parent;
1.115 schwarze 138: man->last->flags |= NODE_VALID;
1.19 kristaps 139: }
1.89 schwarze 140:
141: /*
142: * If we ended up at the parent of the node we were
143: * supposed to rewind to, that means the target node
144: * got deleted, so add the next node we parse as a child
145: * of the parent instead of as a sibling of the target.
146: */
147:
148: man->next = (man->last == to) ?
1.105 schwarze 149: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.19 kristaps 150: }
1.1 kristaps 151:
1.19 kristaps 152: /*
153: * Rewinding entails ascending the parse tree until a coherent point,
154: * for example, the `SH' macro will close out any intervening `SS'
155: * scopes. When a scope is closed, it must be validated and actioned.
156: */
1.91 schwarze 157: static void
1.116 schwarze 158: rew_scope(struct roff_man *man, enum roff_tok tok)
1.19 kristaps 159: {
1.102 schwarze 160: struct roff_node *n;
1.7 kristaps 161:
1.104 schwarze 162: /* Preserve empty paragraphs before RS. */
163:
164: n = man->last;
1.114 schwarze 165: if (tok == MAN_RS && n->child == NULL &&
1.104 schwarze 166: (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
167: return;
168:
169: for (;;) {
170: if (n->type == ROFFT_ROOT)
171: return;
1.115 schwarze 172: if (n->flags & NODE_VALID) {
1.104 schwarze 173: n = n->parent;
174: continue;
175: }
176: if (n->type != ROFFT_BLOCK) {
177: if (n->parent->type == ROFFT_ROOT) {
178: man_unscope(man, n);
179: return;
180: } else {
181: n = n->parent;
182: continue;
183: }
184: }
185: if (tok != MAN_SH && (n->tok == MAN_SH ||
186: (tok != MAN_SS && (n->tok == MAN_SS ||
1.127 schwarze 187: man_macro(n->tok)->fp == blk_exp))))
1.91 schwarze 188: return;
1.104 schwarze 189: man_unscope(man, n);
190: n = man->last;
1.6 kristaps 191: }
1.19 kristaps 192: }
193:
1.6 kristaps 194:
1.36 kristaps 195: /*
196: * Close out a generic explicit macro.
197: */
1.91 schwarze 198: void
1.21 kristaps 199: blk_close(MACRO_PROT_ARGS)
200: {
1.124 schwarze 201: enum roff_tok ctok, ntok;
1.102 schwarze 202: const struct roff_node *nn;
1.137 schwarze 203: char *p, *ep;
204: int cline, cpos, la, nrew, target;
1.21 kristaps 205:
1.93 schwarze 206: nrew = 1;
1.21 kristaps 207: switch (tok) {
1.82 schwarze 208: case MAN_RE:
1.21 kristaps 209: ntok = MAN_RS;
1.137 schwarze 210: la = *pos;
1.93 schwarze 211: if ( ! man_args(man, line, pos, buf, &p))
212: break;
213: for (nn = man->last->parent; nn; nn = nn->parent)
1.101 schwarze 214: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.93 schwarze 215: nrew++;
1.137 schwarze 216: target = strtol(p, &ep, 10);
217: if (*ep != '\0')
1.135 schwarze 218: mandoc_msg(MANDOCERR_ARG_EXCESS, line,
1.137 schwarze 219: la + (buf[la] == '"') + (int)(ep - p),
220: "RE ... %s", ep);
221: free(p);
1.93 schwarze 222: if (target == 0)
223: target = 1;
224: nrew -= target;
225: if (nrew < 1) {
1.135 schwarze 226: mandoc_msg(MANDOCERR_RE_NOTOPEN,
1.93 schwarze 227: line, ppos, "RE %d", target);
228: return;
229: }
1.128 schwarze 230: break;
231: case MAN_YS:
232: ntok = MAN_SY;
1.76 schwarze 233: break;
1.82 schwarze 234: case MAN_UE:
1.76 schwarze 235: ntok = MAN_UR;
1.123 schwarze 236: break;
237: case MAN_ME:
238: ntok = MAN_MT;
1.21 kristaps 239: break;
240: default:
241: abort();
242: }
243:
1.75 schwarze 244: for (nn = man->last->parent; nn; nn = nn->parent)
1.101 schwarze 245: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.21 kristaps 246: break;
247:
1.91 schwarze 248: if (nn == NULL) {
1.135 schwarze 249: mandoc_msg(MANDOCERR_BLK_NOTOPEN,
250: line, ppos, "%s", roff_name[tok]);
1.104 schwarze 251: rew_scope(man, MAN_PP);
1.131 schwarze 252: if (tok == MAN_RE) {
253: roff_elem_alloc(man, line, ppos, ROFF_br);
254: man->last->flags |= NODE_LINE |
255: NODE_VALID | NODE_ENDED;
256: man->next = ROFF_NEXT_SIBLING;
257: }
1.124 schwarze 258: return;
259: }
260:
261: cline = man->last->line;
262: cpos = man->last->pos;
263: ctok = man->last->tok;
264: man_unscope(man, nn);
265:
266: if (tok == MAN_RE && nn->head->aux > 0)
267: roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
268:
269: /* Trailing text. */
270:
271: if (buf[*pos] != '\0') {
272: roff_word_alloc(man, line, ppos, buf + *pos);
273: man->last->flags |= NODE_DELIMC;
1.130 schwarze 274: if (mandoc_eos(man->last->string, strlen(man->last->string)))
275: man->last->flags |= NODE_EOS;
1.124 schwarze 276: }
277:
278: /* Move a trailing paragraph behind the block. */
279:
280: if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
281: *pos = strlen(buf);
1.125 schwarze 282: blk_imp(man, ctok, cline, cpos, pos, buf);
1.129 schwarze 283: }
284:
285: /* Synopsis blocks need an explicit end marker for spacing. */
286:
287: if (tok == MAN_YS && man->last == nn) {
288: roff_elem_alloc(man, line, ppos, tok);
289: man_unscope(man, man->last);
1.95 schwarze 290: }
1.21 kristaps 291: }
292:
1.91 schwarze 293: void
1.35 kristaps 294: blk_exp(MACRO_PROT_ARGS)
295: {
1.102 schwarze 296: struct roff_node *head;
1.98 schwarze 297: char *p;
1.59 kristaps 298: int la;
1.35 kristaps 299:
1.132 schwarze 300: if (tok == MAN_RS)
301: rew_scope(man, tok);
1.108 schwarze 302: roff_block_alloc(man, line, ppos, tok);
1.106 schwarze 303: head = roff_head_alloc(man, line, ppos, tok);
1.35 kristaps 304:
1.98 schwarze 305: la = *pos;
1.121 schwarze 306: if (man_args(man, line, pos, buf, &p)) {
1.107 schwarze 307: roff_word_alloc(man, line, la, p);
1.121 schwarze 308: if (tok == MAN_RS) {
309: if (roff_getreg(man->roff, "an-margin") == 0)
310: roff_setreg(man->roff, "an-margin",
311: 7 * 24, '=');
312: if ((head->aux = strtod(p, NULL) * 24.0) > 0)
313: roff_setreg(man->roff, "an-margin",
314: head->aux, '+');
315: }
1.137 schwarze 316: free(p);
1.121 schwarze 317: }
1.35 kristaps 318:
1.98 schwarze 319: if (buf[*pos] != '\0')
1.135 schwarze 320: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
321: "%s ... %s", roff_name[tok], buf + *pos);
1.73 schwarze 322:
1.98 schwarze 323: man_unscope(man, head);
1.106 schwarze 324: roff_body_alloc(man, line, ppos, tok);
1.35 kristaps 325: }
326:
1.19 kristaps 327: /*
1.101 schwarze 328: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
329: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.19 kristaps 330: * scopes, such as `SH' closing out an `SS', are defined in the rew
331: * routines.
332: */
1.91 schwarze 333: void
1.19 kristaps 334: blk_imp(MACRO_PROT_ARGS)
335: {
1.59 kristaps 336: int la;
1.19 kristaps 337: char *p;
1.102 schwarze 338: struct roff_node *n;
1.19 kristaps 339:
1.104 schwarze 340: rew_scope(man, tok);
1.140 ! schwarze 341: if (tok == MAN_SH || tok == MAN_SS)
! 342: man->flags &= ~ROFF_NOFILL;
! 343: roff_block_alloc(man, line, ppos, tok);
1.106 schwarze 344: n = roff_head_alloc(man, line, ppos, tok);
1.25 kristaps 345:
1.19 kristaps 346: /* Add line arguments. */
1.3 kristaps 347:
1.19 kristaps 348: for (;;) {
349: la = *pos;
1.75 schwarze 350: if ( ! man_args(man, line, pos, buf, &p))
1.19 kristaps 351: break;
1.107 schwarze 352: roff_word_alloc(man, line, la, p);
1.137 schwarze 353: free(p);
1.6 kristaps 354: }
355:
1.99 schwarze 356: /*
357: * For macros having optional next-line scope,
358: * keep the head open if there were no arguments.
1.133 schwarze 359: * For `TP' and `TQ', always keep the head open.
1.99 schwarze 360: */
1.19 kristaps 361:
1.133 schwarze 362: if (man_macro(tok)->flags & MAN_BSCOPED &&
1.126 schwarze 363: (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
1.99 schwarze 364: man->flags |= MAN_BLINE;
365: return;
1.27 kristaps 366: }
1.99 schwarze 367:
368: /* Close out the head and open the body. */
369:
1.103 schwarze 370: man_unscope(man, n);
1.106 schwarze 371: roff_body_alloc(man, line, ppos, tok);
1.4 kristaps 372: }
373:
1.91 schwarze 374: void
1.19 kristaps 375: in_line_eoln(MACRO_PROT_ARGS)
1.3 kristaps 376: {
1.59 kristaps 377: int la;
1.19 kristaps 378: char *p;
1.102 schwarze 379: struct roff_node *n;
1.3 kristaps 380:
1.108 schwarze 381: roff_elem_alloc(man, line, ppos, tok);
1.75 schwarze 382: n = man->last;
1.3 kristaps 383:
1.19 kristaps 384: for (;;) {
1.120 schwarze 385: if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
1.135 schwarze 386: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
387: "%s ... %s", roff_name[tok], buf + *pos);
1.96 schwarze 388: break;
389: }
1.19 kristaps 390: la = *pos;
1.75 schwarze 391: if ( ! man_args(man, line, pos, buf, &p))
1.19 kristaps 392: break;
1.127 schwarze 393: if (man_macro(tok)->flags & MAN_JOIN &&
1.101 schwarze 394: man->last->type == ROFFT_TEXT)
1.107 schwarze 395: roff_word_append(man, p);
1.91 schwarze 396: else
1.107 schwarze 397: roff_word_alloc(man, line, la, p);
1.137 schwarze 398: free(p);
1.19 kristaps 399: }
1.78 schwarze 400:
401: /*
1.115 schwarze 402: * Append NODE_EOS in case the last snipped argument
1.78 schwarze 403: * ends with a dot, e.g. `.IR syslog (3).'
404: */
405:
406: if (n != man->last &&
1.80 schwarze 407: mandoc_eos(man->last->string, strlen(man->last->string)))
1.115 schwarze 408: man->last->flags |= NODE_EOS;
1.3 kristaps 409:
1.31 kristaps 410: /*
1.133 schwarze 411: * If no arguments are specified and this is MAN_ESCOPED (i.e.,
1.31 kristaps 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.133 schwarze 416: if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) {
1.75 schwarze 417: man->flags |= MAN_ELINE;
1.91 schwarze 418: return;
1.31 kristaps 419: }
1.64 kristaps 420:
1.101 schwarze 421: assert(man->last->type != ROFFT_ROOT);
1.105 schwarze 422: man->next = ROFF_NEXT_SIBLING;
1.82 schwarze 423:
1.113 schwarze 424: /* Rewind our element scope. */
1.3 kristaps 425:
1.75 schwarze 426: for ( ; man->last; man->last = man->last->parent) {
1.113 schwarze 427: man_state(man, man->last);
1.75 schwarze 428: if (man->last == n)
1.19 kristaps 429: break;
430: }
1.133 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.19 kristaps 436: }
1.3 kristaps 437:
1.91 schwarze 438: void
1.109 schwarze 439: man_endparse(struct roff_man *man)
1.19 kristaps 440: {
1.138 schwarze 441: man_unscope(man, man->meta.first);
1.19 kristaps 442: }
1.3 kristaps 443:
1.60 kristaps 444: static int
1.105 schwarze 445: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.60 kristaps 446: {
447: char *start;
448:
449: assert(*pos);
450: *v = start = buf + *pos;
451: assert(' ' != *start);
452:
453: if ('\0' == *start)
1.112 schwarze 454: return 0;
1.60 kristaps 455:
1.137 schwarze 456: *v = roff_getarg(man->roff, v, line, pos);
1.112 schwarze 457: return 1;
1.60 kristaps 458: }
CVSweb