Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.92
1.92 ! schwarze 1: /* $OpenBSD: man_macro.c,v 1.91 2018/08/18 14:02:52 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>
23: #include <stdlib.h>
24: #include <string.h>
25:
1.63 schwarze 26: #include "mandoc.h"
27: #include "roff.h"
1.29 schwarze 28: #include "man.h"
29: #include "libmandoc.h"
1.68 schwarze 30: #include "roff_int.h"
1.1 kristaps 31: #include "libman.h"
32:
1.53 schwarze 33: static void blk_close(MACRO_PROT_ARGS);
34: static void blk_exp(MACRO_PROT_ARGS);
35: static void blk_imp(MACRO_PROT_ARGS);
36: static void in_line_eoln(MACRO_PROT_ARGS);
1.67 schwarze 37: static int man_args(struct roff_man *, int,
1.29 schwarze 38: int *, char *, char **);
1.78 schwarze 39: static void rew_scope(struct roff_man *, enum roff_tok);
1.6 schwarze 40:
1.89 schwarze 41: static const struct man_macro man_macros[MAN_MAX - MAN_TH] = {
1.32 schwarze 42: { in_line_eoln, MAN_BSCOPE }, /* TH */
43: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
44: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
1.61 schwarze 45: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TP */
1.88 schwarze 46: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TQ */
1.32 schwarze 47: { blk_imp, MAN_BSCOPE }, /* LP */
48: { blk_imp, MAN_BSCOPE }, /* PP */
49: { blk_imp, MAN_BSCOPE }, /* P */
50: { blk_imp, MAN_BSCOPE }, /* IP */
51: { blk_imp, MAN_BSCOPE }, /* HP */
1.52 schwarze 52: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
53: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
1.6 schwarze 54: { in_line_eoln, 0 }, /* BI */
55: { in_line_eoln, 0 }, /* IB */
56: { in_line_eoln, 0 }, /* BR */
57: { in_line_eoln, 0 }, /* RB */
1.52 schwarze 58: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
59: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
60: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
1.6 schwarze 61: { in_line_eoln, 0 }, /* IR */
62: { in_line_eoln, 0 }, /* RI */
1.72 schwarze 63: { in_line_eoln, MAN_NSCOPED }, /* nf */
64: { in_line_eoln, MAN_NSCOPED }, /* fi */
1.54 schwarze 65: { blk_close, MAN_BSCOPE }, /* RE */
1.61 schwarze 66: { blk_exp, MAN_BSCOPE }, /* RS */
1.7 schwarze 67: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 68: { in_line_eoln, 0 }, /* UC */
1.62 schwarze 69: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.18 schwarze 70: { in_line_eoln, 0 }, /* AT */
1.84 schwarze 71: { in_line_eoln, MAN_NSCOPED }, /* in */
1.91 schwarze 72: { blk_imp, MAN_BSCOPE }, /* SY */
1.90 schwarze 73: { blk_close, MAN_BSCOPE }, /* YS */
1.34 schwarze 74: { in_line_eoln, 0 }, /* OP */
1.35 schwarze 75: { in_line_eoln, MAN_BSCOPE }, /* EX */
76: { in_line_eoln, MAN_BSCOPE }, /* EE */
1.61 schwarze 77: { blk_exp, MAN_BSCOPE }, /* UR */
1.54 schwarze 78: { blk_close, MAN_BSCOPE }, /* UE */
1.85 bentley 79: { blk_exp, MAN_BSCOPE }, /* MT */
80: { blk_close, MAN_BSCOPE }, /* ME */
1.6 schwarze 81: };
1.1 kristaps 82:
83:
1.89 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.53 schwarze 91: void
1.67 schwarze 92: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1 kristaps 93: {
1.64 schwarze 94: struct roff_node *n;
1.1 kristaps 95:
1.46 schwarze 96: to = to->parent;
97: n = man->last;
98: while (n != to) {
1.50 schwarze 99:
100: /* Reached the end of the document? */
101:
1.77 schwarze 102: if (to == NULL && ! (n->flags & NODE_VALID)) {
1.50 schwarze 103: if (man->flags & (MAN_BLINE | MAN_ELINE) &&
1.89 schwarze 104: man_macro(n->tok)->flags & MAN_SCOPED) {
1.50 schwarze 105: mandoc_vmsg(MANDOCERR_BLK_LINE,
106: man->parse, n->line, n->pos,
1.78 schwarze 107: "EOF breaks %s", roff_name[n->tok]);
1.50 schwarze 108: if (man->flags & MAN_ELINE)
109: man->flags &= ~MAN_ELINE;
110: else {
1.63 schwarze 111: assert(n->type == ROFFT_HEAD);
1.50 schwarze 112: n = n->parent;
113: man->flags &= ~MAN_BLINE;
114: }
115: man->last = n;
116: n = n->parent;
1.68 schwarze 117: roff_node_delete(man, man->last);
1.50 schwarze 118: continue;
119: }
1.63 schwarze 120: if (n->type == ROFFT_BLOCK &&
1.89 schwarze 121: man_macro(n->tok)->fp == blk_exp)
1.50 schwarze 122: mandoc_msg(MANDOCERR_BLK_NOEND,
123: man->parse, n->line, n->pos,
1.78 schwarze 124: roff_name[n->tok]);
1.50 schwarze 125: }
126:
1.27 schwarze 127: /*
1.46 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.27 schwarze 132: */
1.51 schwarze 133:
1.46 schwarze 134: man->last = n;
135: n = n->parent;
1.77 schwarze 136: man->last->flags |= NODE_VALID;
1.6 schwarze 137: }
1.51 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.67 schwarze 147: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.6 schwarze 148: }
1.1 kristaps 149:
1.6 schwarze 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.53 schwarze 155: static void
1.78 schwarze 156: rew_scope(struct roff_man *man, enum roff_tok tok)
1.6 schwarze 157: {
1.64 schwarze 158: struct roff_node *n;
1.1 kristaps 159:
1.66 schwarze 160: /* Preserve empty paragraphs before RS. */
161:
162: n = man->last;
1.76 schwarze 163: if (tok == MAN_RS && n->child == NULL &&
1.66 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.77 schwarze 170: if (n->flags & NODE_VALID) {
1.66 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.89 schwarze 185: man_macro(n->tok)->fp == blk_exp))))
1.53 schwarze 186: return;
1.66 schwarze 187: man_unscope(man, n);
188: n = man->last;
1.1 kristaps 189: }
1.6 schwarze 190: }
191:
1.1 kristaps 192:
1.12 schwarze 193: /*
194: * Close out a generic explicit macro.
195: */
1.53 schwarze 196: void
1.7 schwarze 197: blk_close(MACRO_PROT_ARGS)
198: {
1.86 schwarze 199: enum roff_tok ctok, ntok;
1.64 schwarze 200: const struct roff_node *nn;
1.55 schwarze 201: char *p;
1.86 schwarze 202: int cline, cpos, nrew, target;
1.7 schwarze 203:
1.55 schwarze 204: nrew = 1;
1.7 schwarze 205: switch (tok) {
1.45 schwarze 206: case MAN_RE:
1.7 schwarze 207: ntok = MAN_RS;
1.55 schwarze 208: if ( ! man_args(man, line, pos, buf, &p))
209: break;
210: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 211: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.55 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.90 schwarze 225: break;
226: case MAN_YS:
227: ntok = MAN_SY;
1.39 schwarze 228: break;
1.45 schwarze 229: case MAN_UE:
1.39 schwarze 230: ntok = MAN_UR;
1.85 bentley 231: break;
232: case MAN_ME:
233: ntok = MAN_MT;
1.7 schwarze 234: break;
235: default:
236: abort();
237: }
238:
1.38 schwarze 239: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 240: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.7 schwarze 241: break;
242:
1.53 schwarze 243: if (nn == NULL) {
1.47 schwarze 244: mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
1.78 schwarze 245: line, ppos, roff_name[tok]);
1.66 schwarze 246: rew_scope(man, MAN_PP);
1.86 schwarze 247: return;
248: }
249:
250: cline = man->last->line;
251: cpos = man->last->pos;
252: ctok = man->last->tok;
253: man_unscope(man, nn);
254:
255: if (tok == MAN_RE && nn->head->aux > 0)
256: roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
257:
258: /* Trailing text. */
259:
260: if (buf[*pos] != '\0') {
261: roff_word_alloc(man, line, ppos, buf + *pos);
262: man->last->flags |= NODE_DELIMC;
1.92 ! schwarze 263: if (mandoc_eos(man->last->string, strlen(man->last->string)))
! 264: man->last->flags |= NODE_EOS;
1.86 schwarze 265: }
266:
267: /* Move a trailing paragraph behind the block. */
268:
269: if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
270: *pos = strlen(buf);
1.87 schwarze 271: blk_imp(man, ctok, cline, cpos, pos, buf);
1.91 schwarze 272: }
273:
274: /* Synopsis blocks need an explicit end marker for spacing. */
275:
276: if (tok == MAN_YS && man->last == nn) {
277: roff_elem_alloc(man, line, ppos, tok);
278: man_unscope(man, man->last);
1.57 schwarze 279: }
1.7 schwarze 280: }
281:
1.53 schwarze 282: void
1.12 schwarze 283: blk_exp(MACRO_PROT_ARGS)
284: {
1.64 schwarze 285: struct roff_node *head;
1.60 schwarze 286: char *p;
1.29 schwarze 287: int la;
1.12 schwarze 288:
1.66 schwarze 289: rew_scope(man, tok);
1.70 schwarze 290: roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 291: head = roff_head_alloc(man, line, ppos, tok);
1.12 schwarze 292:
1.60 schwarze 293: la = *pos;
1.83 schwarze 294: if (man_args(man, line, pos, buf, &p)) {
1.69 schwarze 295: roff_word_alloc(man, line, la, p);
1.83 schwarze 296: if (tok == MAN_RS) {
297: if (roff_getreg(man->roff, "an-margin") == 0)
298: roff_setreg(man->roff, "an-margin",
299: 7 * 24, '=');
300: if ((head->aux = strtod(p, NULL) * 24.0) > 0)
301: roff_setreg(man->roff, "an-margin",
302: head->aux, '+');
303: }
304: }
1.12 schwarze 305:
1.60 schwarze 306: if (buf[*pos] != '\0')
1.78 schwarze 307: mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, line,
308: *pos, "%s ... %s", roff_name[tok], buf + *pos);
1.36 schwarze 309:
1.60 schwarze 310: man_unscope(man, head);
1.68 schwarze 311: roff_body_alloc(man, line, ppos, tok);
1.12 schwarze 312: }
313:
1.6 schwarze 314: /*
1.63 schwarze 315: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
316: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.6 schwarze 317: * scopes, such as `SH' closing out an `SS', are defined in the rew
318: * routines.
319: */
1.53 schwarze 320: void
1.6 schwarze 321: blk_imp(MACRO_PROT_ARGS)
322: {
1.29 schwarze 323: int la;
1.6 schwarze 324: char *p;
1.64 schwarze 325: struct roff_node *n;
1.6 schwarze 326:
1.66 schwarze 327: rew_scope(man, tok);
1.70 schwarze 328: n = roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 329: if (n->tok == MAN_SH || n->tok == MAN_SS)
330: man->flags &= ~MAN_LITERAL;
331: n = roff_head_alloc(man, line, ppos, tok);
1.7 schwarze 332:
1.6 schwarze 333: /* Add line arguments. */
1.1 kristaps 334:
1.6 schwarze 335: for (;;) {
336: la = *pos;
1.38 schwarze 337: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 338: break;
1.69 schwarze 339: roff_word_alloc(man, line, la, p);
1.1 kristaps 340: }
341:
1.61 schwarze 342: /*
343: * For macros having optional next-line scope,
344: * keep the head open if there were no arguments.
345: * For `TP', always keep the head open.
346: */
1.6 schwarze 347:
1.89 schwarze 348: if (man_macro(tok)->flags & MAN_SCOPED &&
1.88 schwarze 349: (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
1.61 schwarze 350: man->flags |= MAN_BLINE;
351: return;
1.7 schwarze 352: }
1.61 schwarze 353:
354: /* Close out the head and open the body. */
355:
1.65 schwarze 356: man_unscope(man, n);
1.68 schwarze 357: roff_body_alloc(man, line, ppos, tok);
1.1 kristaps 358: }
359:
1.53 schwarze 360: void
1.6 schwarze 361: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 362: {
1.29 schwarze 363: int la;
1.6 schwarze 364: char *p;
1.64 schwarze 365: struct roff_node *n;
1.1 kristaps 366:
1.70 schwarze 367: roff_elem_alloc(man, line, ppos, tok);
1.38 schwarze 368: n = man->last;
1.1 kristaps 369:
1.6 schwarze 370: for (;;) {
1.79 schwarze 371: if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
1.58 schwarze 372: mandoc_vmsg(MANDOCERR_ARG_SKIP,
373: man->parse, line, *pos, "%s %s",
1.78 schwarze 374: roff_name[tok], buf + *pos);
1.59 schwarze 375: break;
376: }
1.82 schwarze 377: if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
1.59 schwarze 378: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
379: man->parse, line, *pos, "%s ... %s",
1.78 schwarze 380: roff_name[tok], buf + *pos);
1.58 schwarze 381: break;
382: }
1.6 schwarze 383: la = *pos;
1.38 schwarze 384: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 385: break;
1.89 schwarze 386: if (man_macro(tok)->flags & MAN_JOIN &&
1.63 schwarze 387: man->last->type == ROFFT_TEXT)
1.69 schwarze 388: roff_word_append(man, p);
1.53 schwarze 389: else
1.69 schwarze 390: roff_word_alloc(man, line, la, p);
1.6 schwarze 391: }
1.41 schwarze 392:
393: /*
1.77 schwarze 394: * Append NODE_EOS in case the last snipped argument
1.41 schwarze 395: * ends with a dot, e.g. `.IR syslog (3).'
396: */
397:
398: if (n != man->last &&
1.43 schwarze 399: mandoc_eos(man->last->string, strlen(man->last->string)))
1.77 schwarze 400: man->last->flags |= NODE_EOS;
1.1 kristaps 401:
1.11 schwarze 402: /*
403: * If no arguments are specified and this is MAN_SCOPED (i.e.,
404: * next-line scoped), then set our mode to indicate that we're
405: * waiting for terms to load into our context.
406: */
407:
1.89 schwarze 408: if (n == man->last && man_macro(tok)->flags & MAN_SCOPED) {
409: assert((man_macro(tok)->flags & MAN_NSCOPED) == 0);
1.38 schwarze 410: man->flags |= MAN_ELINE;
1.53 schwarze 411: return;
1.11 schwarze 412: }
1.31 schwarze 413:
1.63 schwarze 414: assert(man->last->type != ROFFT_ROOT);
1.67 schwarze 415: man->next = ROFF_NEXT_SIBLING;
1.45 schwarze 416:
1.75 schwarze 417: /* Rewind our element scope. */
1.1 kristaps 418:
1.38 schwarze 419: for ( ; man->last; man->last = man->last->parent) {
1.75 schwarze 420: man_state(man, man->last);
1.38 schwarze 421: if (man->last == n)
1.6 schwarze 422: break;
423: }
424: }
1.1 kristaps 425:
1.53 schwarze 426: void
1.71 schwarze 427: man_endparse(struct roff_man *man)
1.6 schwarze 428: {
1.1 kristaps 429:
1.53 schwarze 430: man_unscope(man, man->first);
1.75 schwarze 431: man->flags &= ~MAN_LITERAL;
1.6 schwarze 432: }
1.1 kristaps 433:
1.29 schwarze 434: static int
1.67 schwarze 435: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 436: {
437: char *start;
438:
439: assert(*pos);
440: *v = start = buf + *pos;
441: assert(' ' != *start);
442:
443: if ('\0' == *start)
1.74 schwarze 444: return 0;
1.29 schwarze 445:
1.38 schwarze 446: *v = mandoc_getarg(man->parse, v, line, pos);
1.74 schwarze 447: return 1;
1.29 schwarze 448: }
![[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