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