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