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