Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.100
1.100 ! schwarze 1: /* $OpenBSD: man_macro.c,v 1.99 2018/12/21 16:58:49 schwarze Exp $ */
1.1 kristaps 2: /*
1.29 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.86 schwarze 4: * Copyright (c) 2012-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
1.42 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.2 schwarze 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.63 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.63 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 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.51 schwarze 19: #include <sys/types.h>
20:
1.1 kristaps 21: #include <assert.h>
22: #include <ctype.h>
1.96 schwarze 23: #include <stdio.h>
1.1 kristaps 24: #include <stdlib.h>
25: #include <string.h>
26:
1.63 schwarze 27: #include "mandoc.h"
28: #include "roff.h"
1.29 schwarze 29: #include "man.h"
30: #include "libmandoc.h"
1.68 schwarze 31: #include "roff_int.h"
1.1 kristaps 32: #include "libman.h"
33:
1.53 schwarze 34: static void blk_close(MACRO_PROT_ARGS);
35: static void blk_exp(MACRO_PROT_ARGS);
36: static void blk_imp(MACRO_PROT_ARGS);
37: static void in_line_eoln(MACRO_PROT_ARGS);
1.67 schwarze 38: static int man_args(struct roff_man *, int,
1.29 schwarze 39: int *, char *, char **);
1.78 schwarze 40: static void rew_scope(struct roff_man *, enum roff_tok);
1.6 schwarze 41:
1.89 schwarze 42: static const struct man_macro man_macros[MAN_MAX - MAN_TH] = {
1.95 schwarze 43: { in_line_eoln, MAN_XSCOPE }, /* TH */
44: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SH */
45: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SS */
46: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TP */
47: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TQ */
48: { blk_imp, MAN_XSCOPE }, /* LP */
49: { blk_imp, MAN_XSCOPE }, /* PP */
50: { blk_imp, MAN_XSCOPE }, /* P */
51: { blk_imp, MAN_XSCOPE }, /* IP */
52: { blk_imp, MAN_XSCOPE }, /* HP */
53: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SM */
54: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SB */
1.6 schwarze 55: { in_line_eoln, 0 }, /* BI */
56: { in_line_eoln, 0 }, /* IB */
57: { in_line_eoln, 0 }, /* BR */
58: { in_line_eoln, 0 }, /* RB */
1.95 schwarze 59: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* R */
60: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* B */
61: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* I */
1.6 schwarze 62: { in_line_eoln, 0 }, /* IR */
63: { in_line_eoln, 0 }, /* RI */
1.72 schwarze 64: { in_line_eoln, MAN_NSCOPED }, /* nf */
65: { in_line_eoln, MAN_NSCOPED }, /* fi */
1.95 schwarze 66: { blk_close, MAN_XSCOPE }, /* RE */
67: { blk_exp, MAN_XSCOPE }, /* RS */
1.7 schwarze 68: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 69: { in_line_eoln, 0 }, /* UC */
1.62 schwarze 70: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.18 schwarze 71: { in_line_eoln, 0 }, /* AT */
1.84 schwarze 72: { in_line_eoln, MAN_NSCOPED }, /* in */
1.95 schwarze 73: { blk_imp, MAN_XSCOPE }, /* SY */
74: { blk_close, MAN_XSCOPE }, /* YS */
1.34 schwarze 75: { in_line_eoln, 0 }, /* OP */
1.95 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.6 schwarze 82: };
1.1 kristaps 83:
84:
1.89 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.53 schwarze 92: void
1.67 schwarze 93: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1 kristaps 94: {
1.64 schwarze 95: struct roff_node *n;
1.1 kristaps 96:
1.46 schwarze 97: to = to->parent;
98: n = man->last;
99: while (n != to) {
1.50 schwarze 100:
101: /* Reached the end of the document? */
102:
1.77 schwarze 103: if (to == NULL && ! (n->flags & NODE_VALID)) {
1.50 schwarze 104: if (man->flags & (MAN_BLINE | MAN_ELINE) &&
1.95 schwarze 105: man_macro(n->tok)->flags &
106: (MAN_BSCOPED | MAN_NSCOPED)) {
1.97 schwarze 107: mandoc_msg(MANDOCERR_BLK_LINE,
108: n->line, n->pos,
1.78 schwarze 109: "EOF breaks %s", roff_name[n->tok]);
1.50 schwarze 110: if (man->flags & MAN_ELINE)
111: man->flags &= ~MAN_ELINE;
112: else {
1.63 schwarze 113: assert(n->type == ROFFT_HEAD);
1.50 schwarze 114: n = n->parent;
115: man->flags &= ~MAN_BLINE;
116: }
117: man->last = n;
118: n = n->parent;
1.68 schwarze 119: roff_node_delete(man, man->last);
1.50 schwarze 120: continue;
121: }
1.63 schwarze 122: if (n->type == ROFFT_BLOCK &&
1.89 schwarze 123: man_macro(n->tok)->fp == blk_exp)
1.50 schwarze 124: mandoc_msg(MANDOCERR_BLK_NOEND,
1.97 schwarze 125: n->line, n->pos, "%s",
1.78 schwarze 126: roff_name[n->tok]);
1.50 schwarze 127: }
128:
1.27 schwarze 129: /*
1.46 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.27 schwarze 134: */
1.51 schwarze 135:
1.46 schwarze 136: man->last = n;
137: n = n->parent;
1.77 schwarze 138: man->last->flags |= NODE_VALID;
1.6 schwarze 139: }
1.51 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.67 schwarze 149: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.6 schwarze 150: }
1.1 kristaps 151:
1.6 schwarze 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.53 schwarze 157: static void
1.78 schwarze 158: rew_scope(struct roff_man *man, enum roff_tok tok)
1.6 schwarze 159: {
1.64 schwarze 160: struct roff_node *n;
1.1 kristaps 161:
1.66 schwarze 162: /* Preserve empty paragraphs before RS. */
163:
164: n = man->last;
1.76 schwarze 165: if (tok == MAN_RS && n->child == NULL &&
1.66 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.77 schwarze 172: if (n->flags & NODE_VALID) {
1.66 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.89 schwarze 187: man_macro(n->tok)->fp == blk_exp))))
1.53 schwarze 188: return;
1.66 schwarze 189: man_unscope(man, n);
190: n = man->last;
1.1 kristaps 191: }
1.6 schwarze 192: }
193:
1.1 kristaps 194:
1.12 schwarze 195: /*
196: * Close out a generic explicit macro.
197: */
1.53 schwarze 198: void
1.7 schwarze 199: blk_close(MACRO_PROT_ARGS)
200: {
1.86 schwarze 201: enum roff_tok ctok, ntok;
1.64 schwarze 202: const struct roff_node *nn;
1.99 schwarze 203: char *p, *ep;
204: int cline, cpos, la, nrew, target;
1.7 schwarze 205:
1.55 schwarze 206: nrew = 1;
1.7 schwarze 207: switch (tok) {
1.45 schwarze 208: case MAN_RE:
1.7 schwarze 209: ntok = MAN_RS;
1.99 schwarze 210: la = *pos;
1.55 schwarze 211: if ( ! man_args(man, line, pos, buf, &p))
212: break;
213: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 214: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.55 schwarze 215: nrew++;
1.99 schwarze 216: target = strtol(p, &ep, 10);
217: if (*ep != '\0')
1.97 schwarze 218: mandoc_msg(MANDOCERR_ARG_EXCESS, line,
1.99 schwarze 219: la + (buf[la] == '"') + (int)(ep - p),
220: "RE ... %s", ep);
221: free(p);
1.55 schwarze 222: if (target == 0)
223: target = 1;
224: nrew -= target;
225: if (nrew < 1) {
1.97 schwarze 226: mandoc_msg(MANDOCERR_RE_NOTOPEN,
1.55 schwarze 227: line, ppos, "RE %d", target);
228: return;
229: }
1.90 schwarze 230: break;
231: case MAN_YS:
232: ntok = MAN_SY;
1.39 schwarze 233: break;
1.45 schwarze 234: case MAN_UE:
1.39 schwarze 235: ntok = MAN_UR;
1.85 bentley 236: break;
237: case MAN_ME:
238: ntok = MAN_MT;
1.7 schwarze 239: break;
240: default:
241: abort();
242: }
243:
1.38 schwarze 244: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 245: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.7 schwarze 246: break;
247:
1.53 schwarze 248: if (nn == NULL) {
1.97 schwarze 249: mandoc_msg(MANDOCERR_BLK_NOTOPEN,
250: line, ppos, "%s", roff_name[tok]);
1.66 schwarze 251: rew_scope(man, MAN_PP);
1.93 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.86 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.92 schwarze 274: if (mandoc_eos(man->last->string, strlen(man->last->string)))
275: man->last->flags |= NODE_EOS;
1.86 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.87 schwarze 282: blk_imp(man, ctok, cline, cpos, pos, buf);
1.91 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.57 schwarze 290: }
1.7 schwarze 291: }
292:
1.53 schwarze 293: void
1.12 schwarze 294: blk_exp(MACRO_PROT_ARGS)
295: {
1.64 schwarze 296: struct roff_node *head;
1.60 schwarze 297: char *p;
1.29 schwarze 298: int la;
1.12 schwarze 299:
1.94 schwarze 300: if (tok == MAN_RS)
301: rew_scope(man, tok);
1.70 schwarze 302: roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 303: head = roff_head_alloc(man, line, ppos, tok);
1.12 schwarze 304:
1.60 schwarze 305: la = *pos;
1.83 schwarze 306: if (man_args(man, line, pos, buf, &p)) {
1.69 schwarze 307: roff_word_alloc(man, line, la, p);
1.83 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.99 schwarze 316: free(p);
1.83 schwarze 317: }
1.12 schwarze 318:
1.60 schwarze 319: if (buf[*pos] != '\0')
1.97 schwarze 320: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
321: "%s ... %s", roff_name[tok], buf + *pos);
1.36 schwarze 322:
1.60 schwarze 323: man_unscope(man, head);
1.68 schwarze 324: roff_body_alloc(man, line, ppos, tok);
1.12 schwarze 325: }
326:
1.6 schwarze 327: /*
1.63 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.6 schwarze 330: * scopes, such as `SH' closing out an `SS', are defined in the rew
331: * routines.
332: */
1.53 schwarze 333: void
1.6 schwarze 334: blk_imp(MACRO_PROT_ARGS)
335: {
1.29 schwarze 336: int la;
1.6 schwarze 337: char *p;
1.64 schwarze 338: struct roff_node *n;
1.6 schwarze 339:
1.66 schwarze 340: rew_scope(man, tok);
1.70 schwarze 341: n = roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 342: if (n->tok == MAN_SH || n->tok == MAN_SS)
343: man->flags &= ~MAN_LITERAL;
344: n = roff_head_alloc(man, line, ppos, tok);
1.7 schwarze 345:
1.6 schwarze 346: /* Add line arguments. */
1.1 kristaps 347:
1.6 schwarze 348: for (;;) {
349: la = *pos;
1.38 schwarze 350: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 351: break;
1.69 schwarze 352: roff_word_alloc(man, line, la, p);
1.99 schwarze 353: free(p);
1.1 kristaps 354: }
355:
1.61 schwarze 356: /*
357: * For macros having optional next-line scope,
358: * keep the head open if there were no arguments.
1.95 schwarze 359: * For `TP' and `TQ', always keep the head open.
1.61 schwarze 360: */
1.6 schwarze 361:
1.95 schwarze 362: if (man_macro(tok)->flags & MAN_BSCOPED &&
1.88 schwarze 363: (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
1.61 schwarze 364: man->flags |= MAN_BLINE;
365: return;
1.7 schwarze 366: }
1.61 schwarze 367:
368: /* Close out the head and open the body. */
369:
1.65 schwarze 370: man_unscope(man, n);
1.68 schwarze 371: roff_body_alloc(man, line, ppos, tok);
1.1 kristaps 372: }
373:
1.53 schwarze 374: void
1.6 schwarze 375: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 376: {
1.29 schwarze 377: int la;
1.6 schwarze 378: char *p;
1.64 schwarze 379: struct roff_node *n;
1.1 kristaps 380:
1.70 schwarze 381: roff_elem_alloc(man, line, ppos, tok);
1.38 schwarze 382: n = man->last;
1.1 kristaps 383:
1.6 schwarze 384: for (;;) {
1.79 schwarze 385: if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
1.97 schwarze 386: mandoc_msg(MANDOCERR_ARG_SKIP, line, *pos,
387: "%s %s", roff_name[tok], buf + *pos);
1.59 schwarze 388: break;
389: }
1.82 schwarze 390: if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
1.97 schwarze 391: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
392: "%s ... %s", roff_name[tok], buf + *pos);
1.58 schwarze 393: break;
394: }
1.6 schwarze 395: la = *pos;
1.38 schwarze 396: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 397: break;
1.89 schwarze 398: if (man_macro(tok)->flags & MAN_JOIN &&
1.63 schwarze 399: man->last->type == ROFFT_TEXT)
1.69 schwarze 400: roff_word_append(man, p);
1.53 schwarze 401: else
1.69 schwarze 402: roff_word_alloc(man, line, la, p);
1.99 schwarze 403: free(p);
1.6 schwarze 404: }
1.41 schwarze 405:
406: /*
1.77 schwarze 407: * Append NODE_EOS in case the last snipped argument
1.41 schwarze 408: * ends with a dot, e.g. `.IR syslog (3).'
409: */
410:
411: if (n != man->last &&
1.43 schwarze 412: mandoc_eos(man->last->string, strlen(man->last->string)))
1.77 schwarze 413: man->last->flags |= NODE_EOS;
1.1 kristaps 414:
1.11 schwarze 415: /*
1.95 schwarze 416: * If no arguments are specified and this is MAN_ESCOPED (i.e.,
1.11 schwarze 417: * next-line scoped), then set our mode to indicate that we're
418: * waiting for terms to load into our context.
419: */
420:
1.95 schwarze 421: if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) {
1.38 schwarze 422: man->flags |= MAN_ELINE;
1.53 schwarze 423: return;
1.11 schwarze 424: }
1.31 schwarze 425:
1.63 schwarze 426: assert(man->last->type != ROFFT_ROOT);
1.67 schwarze 427: man->next = ROFF_NEXT_SIBLING;
1.45 schwarze 428:
1.75 schwarze 429: /* Rewind our element scope. */
1.1 kristaps 430:
1.38 schwarze 431: for ( ; man->last; man->last = man->last->parent) {
1.75 schwarze 432: man_state(man, man->last);
1.38 schwarze 433: if (man->last == n)
1.6 schwarze 434: break;
435: }
1.95 schwarze 436:
437: /* Rewind next-line scoped ancestors, if any. */
438:
439: if (man_macro(tok)->flags & MAN_ESCOPED)
440: man_descope(man, line, ppos, NULL);
1.6 schwarze 441: }
1.1 kristaps 442:
1.53 schwarze 443: void
1.71 schwarze 444: man_endparse(struct roff_man *man)
1.6 schwarze 445: {
1.1 kristaps 446:
1.100 ! schwarze 447: man_unscope(man, man->meta.first);
1.75 schwarze 448: man->flags &= ~MAN_LITERAL;
1.6 schwarze 449: }
1.1 kristaps 450:
1.29 schwarze 451: static int
1.67 schwarze 452: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 453: {
454: char *start;
455:
456: assert(*pos);
457: *v = start = buf + *pos;
458: assert(' ' != *start);
459:
460: if ('\0' == *start)
1.74 schwarze 461: return 0;
1.29 schwarze 462:
1.99 schwarze 463: *v = roff_getarg(man->roff, v, line, pos);
1.74 schwarze 464: return 1;
1.29 schwarze 465: }
![[BACK]](/icons/back.gif){kind=icon}
Return to man_macro.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc