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