Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.110
1.110 ! schwarze 1: /* $OpenBSD: man_macro.c,v 1.109 2022/04/27 17:04:15 schwarze Exp $ */
1.1 kristaps 2: /*
1.108 schwarze 3: * Copyright (c) 2012-2015,2017-2020,2022 Ingo Schwarze <schwarze@openbsd.org>
1.29 schwarze 4: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
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.95 schwarze 64: { blk_close, MAN_XSCOPE }, /* RE */
65: { blk_exp, MAN_XSCOPE }, /* RS */
1.109 schwarze 66: { in_line_eoln, MAN_NSCOPED }, /* DT */
67: { in_line_eoln, MAN_NSCOPED }, /* UC */
1.62 schwarze 68: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.109 schwarze 69: { in_line_eoln, MAN_NSCOPED }, /* AT */
1.84 schwarze 70: { in_line_eoln, MAN_NSCOPED }, /* in */
1.95 schwarze 71: { blk_imp, MAN_XSCOPE }, /* SY */
72: { blk_close, MAN_XSCOPE }, /* YS */
1.34 schwarze 73: { in_line_eoln, 0 }, /* OP */
1.95 schwarze 74: { in_line_eoln, MAN_XSCOPE }, /* EX */
75: { in_line_eoln, MAN_XSCOPE }, /* EE */
76: { blk_exp, MAN_XSCOPE }, /* UR */
77: { blk_close, MAN_XSCOPE }, /* UE */
78: { blk_exp, MAN_XSCOPE }, /* MT */
79: { blk_close, MAN_XSCOPE }, /* ME */
1.110 ! schwarze 80: { in_line_eoln, 0 }, /* MR */
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.95 schwarze 104: man_macro(n->tok)->flags &
105: (MAN_BSCOPED | MAN_NSCOPED)) {
1.97 schwarze 106: mandoc_msg(MANDOCERR_BLK_LINE,
107: n->line, n->pos,
1.78 schwarze 108: "EOF breaks %s", roff_name[n->tok]);
1.107 schwarze 109: if (man->flags & MAN_ELINE) {
1.108 schwarze 110: if (n->parent->type == ROFFT_ROOT ||
111: (man_macro(n->parent->tok)->flags &
1.107 schwarze 112: MAN_ESCOPED) == 0)
113: man->flags &= ~MAN_ELINE;
114: } else {
1.63 schwarze 115: assert(n->type == ROFFT_HEAD);
1.50 schwarze 116: n = n->parent;
117: man->flags &= ~MAN_BLINE;
118: }
119: man->last = n;
120: n = n->parent;
1.68 schwarze 121: roff_node_delete(man, man->last);
1.50 schwarze 122: continue;
123: }
1.63 schwarze 124: if (n->type == ROFFT_BLOCK &&
1.89 schwarze 125: man_macro(n->tok)->fp == blk_exp)
1.50 schwarze 126: mandoc_msg(MANDOCERR_BLK_NOEND,
1.97 schwarze 127: n->line, n->pos, "%s",
1.78 schwarze 128: roff_name[n->tok]);
1.50 schwarze 129: }
130:
1.27 schwarze 131: /*
1.46 schwarze 132: * We might delete the man->last node
133: * in the post-validation phase.
134: * Save a pointer to the parent such that
135: * we know where to continue the iteration.
1.27 schwarze 136: */
1.51 schwarze 137:
1.46 schwarze 138: man->last = n;
139: n = n->parent;
1.77 schwarze 140: man->last->flags |= NODE_VALID;
1.6 schwarze 141: }
1.51 schwarze 142:
143: /*
144: * If we ended up at the parent of the node we were
145: * supposed to rewind to, that means the target node
146: * got deleted, so add the next node we parse as a child
147: * of the parent instead of as a sibling of the target.
148: */
149:
150: man->next = (man->last == to) ?
1.67 schwarze 151: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.6 schwarze 152: }
1.1 kristaps 153:
1.6 schwarze 154: /*
155: * Rewinding entails ascending the parse tree until a coherent point,
156: * for example, the `SH' macro will close out any intervening `SS'
157: * scopes. When a scope is closed, it must be validated and actioned.
158: */
1.53 schwarze 159: static void
1.78 schwarze 160: rew_scope(struct roff_man *man, enum roff_tok tok)
1.6 schwarze 161: {
1.64 schwarze 162: struct roff_node *n;
1.1 kristaps 163:
1.66 schwarze 164: /* Preserve empty paragraphs before RS. */
165:
166: n = man->last;
1.76 schwarze 167: if (tok == MAN_RS && n->child == NULL &&
1.66 schwarze 168: (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
169: return;
170:
171: for (;;) {
172: if (n->type == ROFFT_ROOT)
173: return;
1.77 schwarze 174: if (n->flags & NODE_VALID) {
1.66 schwarze 175: n = n->parent;
176: continue;
177: }
178: if (n->type != ROFFT_BLOCK) {
179: if (n->parent->type == ROFFT_ROOT) {
180: man_unscope(man, n);
181: return;
182: } else {
183: n = n->parent;
184: continue;
185: }
186: }
187: if (tok != MAN_SH && (n->tok == MAN_SH ||
188: (tok != MAN_SS && (n->tok == MAN_SS ||
1.89 schwarze 189: man_macro(n->tok)->fp == blk_exp))))
1.53 schwarze 190: return;
1.66 schwarze 191: man_unscope(man, n);
192: n = man->last;
1.1 kristaps 193: }
1.6 schwarze 194: }
195:
1.1 kristaps 196:
1.12 schwarze 197: /*
198: * Close out a generic explicit macro.
199: */
1.53 schwarze 200: void
1.7 schwarze 201: blk_close(MACRO_PROT_ARGS)
202: {
1.86 schwarze 203: enum roff_tok ctok, ntok;
1.64 schwarze 204: const struct roff_node *nn;
1.99 schwarze 205: char *p, *ep;
206: int cline, cpos, la, nrew, target;
1.7 schwarze 207:
1.55 schwarze 208: nrew = 1;
1.7 schwarze 209: switch (tok) {
1.45 schwarze 210: case MAN_RE:
1.7 schwarze 211: ntok = MAN_RS;
1.99 schwarze 212: la = *pos;
1.55 schwarze 213: if ( ! man_args(man, line, pos, buf, &p))
214: break;
215: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 216: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.55 schwarze 217: nrew++;
1.99 schwarze 218: target = strtol(p, &ep, 10);
219: if (*ep != '\0')
1.97 schwarze 220: mandoc_msg(MANDOCERR_ARG_EXCESS, line,
1.99 schwarze 221: la + (buf[la] == '"') + (int)(ep - p),
222: "RE ... %s", ep);
223: free(p);
1.55 schwarze 224: if (target == 0)
225: target = 1;
226: nrew -= target;
227: if (nrew < 1) {
1.97 schwarze 228: mandoc_msg(MANDOCERR_RE_NOTOPEN,
1.55 schwarze 229: line, ppos, "RE %d", target);
230: return;
231: }
1.90 schwarze 232: break;
233: case MAN_YS:
234: ntok = MAN_SY;
1.39 schwarze 235: break;
1.45 schwarze 236: case MAN_UE:
1.39 schwarze 237: ntok = MAN_UR;
1.85 bentley 238: break;
239: case MAN_ME:
240: ntok = MAN_MT;
1.7 schwarze 241: break;
242: default:
243: abort();
244: }
245:
1.38 schwarze 246: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 247: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.7 schwarze 248: break;
249:
1.53 schwarze 250: if (nn == NULL) {
1.97 schwarze 251: mandoc_msg(MANDOCERR_BLK_NOTOPEN,
252: line, ppos, "%s", roff_name[tok]);
1.66 schwarze 253: rew_scope(man, MAN_PP);
1.93 schwarze 254: if (tok == MAN_RE) {
255: roff_elem_alloc(man, line, ppos, ROFF_br);
256: man->last->flags |= NODE_LINE |
257: NODE_VALID | NODE_ENDED;
258: man->next = ROFF_NEXT_SIBLING;
259: }
1.86 schwarze 260: return;
261: }
262:
263: cline = man->last->line;
264: cpos = man->last->pos;
265: ctok = man->last->tok;
266: man_unscope(man, nn);
267:
268: if (tok == MAN_RE && nn->head->aux > 0)
269: roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
270:
271: /* Trailing text. */
272:
273: if (buf[*pos] != '\0') {
274: roff_word_alloc(man, line, ppos, buf + *pos);
275: man->last->flags |= NODE_DELIMC;
1.92 schwarze 276: if (mandoc_eos(man->last->string, strlen(man->last->string)))
277: man->last->flags |= NODE_EOS;
1.86 schwarze 278: }
279:
280: /* Move a trailing paragraph behind the block. */
281:
282: if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
283: *pos = strlen(buf);
1.87 schwarze 284: blk_imp(man, ctok, cline, cpos, pos, buf);
1.91 schwarze 285: }
286:
287: /* Synopsis blocks need an explicit end marker for spacing. */
288:
289: if (tok == MAN_YS && man->last == nn) {
290: roff_elem_alloc(man, line, ppos, tok);
291: man_unscope(man, man->last);
1.57 schwarze 292: }
1.7 schwarze 293: }
294:
1.53 schwarze 295: void
1.12 schwarze 296: blk_exp(MACRO_PROT_ARGS)
297: {
1.64 schwarze 298: struct roff_node *head;
1.60 schwarze 299: char *p;
1.29 schwarze 300: int la;
1.12 schwarze 301:
1.106 schwarze 302: if (tok == MAN_RS) {
1.94 schwarze 303: rew_scope(man, tok);
1.106 schwarze 304: man->flags |= ROFF_NONOFILL;
305: }
1.70 schwarze 306: roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 307: head = roff_head_alloc(man, line, ppos, tok);
1.12 schwarze 308:
1.60 schwarze 309: la = *pos;
1.83 schwarze 310: if (man_args(man, line, pos, buf, &p)) {
1.69 schwarze 311: roff_word_alloc(man, line, la, p);
1.83 schwarze 312: if (tok == MAN_RS) {
313: if (roff_getreg(man->roff, "an-margin") == 0)
314: roff_setreg(man->roff, "an-margin",
315: 7 * 24, '=');
316: if ((head->aux = strtod(p, NULL) * 24.0) > 0)
317: roff_setreg(man->roff, "an-margin",
318: head->aux, '+');
319: }
1.99 schwarze 320: free(p);
1.83 schwarze 321: }
1.12 schwarze 322:
1.60 schwarze 323: if (buf[*pos] != '\0')
1.97 schwarze 324: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
325: "%s ... %s", roff_name[tok], buf + *pos);
1.36 schwarze 326:
1.60 schwarze 327: man_unscope(man, head);
1.68 schwarze 328: roff_body_alloc(man, line, ppos, tok);
1.106 schwarze 329: man->flags &= ~ROFF_NONOFILL;
1.12 schwarze 330: }
331:
1.6 schwarze 332: /*
1.63 schwarze 333: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
334: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.6 schwarze 335: * scopes, such as `SH' closing out an `SS', are defined in the rew
336: * routines.
337: */
1.53 schwarze 338: void
1.6 schwarze 339: blk_imp(MACRO_PROT_ARGS)
340: {
1.29 schwarze 341: int la;
1.6 schwarze 342: char *p;
1.64 schwarze 343: struct roff_node *n;
1.6 schwarze 344:
1.66 schwarze 345: rew_scope(man, tok);
1.105 schwarze 346: man->flags |= ROFF_NONOFILL;
1.102 schwarze 347: if (tok == MAN_SH || tok == MAN_SS)
348: man->flags &= ~ROFF_NOFILL;
349: roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 350: n = roff_head_alloc(man, line, ppos, tok);
1.7 schwarze 351:
1.6 schwarze 352: /* Add line arguments. */
1.1 kristaps 353:
1.6 schwarze 354: for (;;) {
355: la = *pos;
1.38 schwarze 356: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 357: break;
1.69 schwarze 358: roff_word_alloc(man, line, la, p);
1.99 schwarze 359: free(p);
1.1 kristaps 360: }
361:
1.61 schwarze 362: /*
363: * For macros having optional next-line scope,
364: * keep the head open if there were no arguments.
1.95 schwarze 365: * For `TP' and `TQ', always keep the head open.
1.61 schwarze 366: */
1.6 schwarze 367:
1.95 schwarze 368: if (man_macro(tok)->flags & MAN_BSCOPED &&
1.88 schwarze 369: (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
1.61 schwarze 370: man->flags |= MAN_BLINE;
371: return;
1.7 schwarze 372: }
1.61 schwarze 373:
374: /* Close out the head and open the body. */
375:
1.65 schwarze 376: man_unscope(man, n);
1.68 schwarze 377: roff_body_alloc(man, line, ppos, tok);
1.105 schwarze 378: man->flags &= ~ROFF_NONOFILL;
1.1 kristaps 379: }
380:
1.53 schwarze 381: void
1.6 schwarze 382: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 383: {
1.29 schwarze 384: int la;
1.6 schwarze 385: char *p;
1.64 schwarze 386: struct roff_node *n;
1.1 kristaps 387:
1.70 schwarze 388: roff_elem_alloc(man, line, ppos, tok);
1.38 schwarze 389: n = man->last;
1.103 schwarze 390:
391: if (tok == MAN_EX)
392: man->flags |= ROFF_NOFILL;
393: else if (tok == MAN_EE)
394: man->flags &= ~ROFF_NOFILL;
1.1 kristaps 395:
1.6 schwarze 396: for (;;) {
1.82 schwarze 397: if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
1.97 schwarze 398: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
399: "%s ... %s", roff_name[tok], buf + *pos);
1.58 schwarze 400: break;
401: }
1.6 schwarze 402: la = *pos;
1.38 schwarze 403: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 404: break;
1.89 schwarze 405: if (man_macro(tok)->flags & MAN_JOIN &&
1.63 schwarze 406: man->last->type == ROFFT_TEXT)
1.69 schwarze 407: roff_word_append(man, p);
1.53 schwarze 408: else
1.69 schwarze 409: roff_word_alloc(man, line, la, p);
1.99 schwarze 410: free(p);
1.6 schwarze 411: }
1.41 schwarze 412:
413: /*
1.77 schwarze 414: * Append NODE_EOS in case the last snipped argument
1.41 schwarze 415: * ends with a dot, e.g. `.IR syslog (3).'
416: */
417:
418: if (n != man->last &&
1.43 schwarze 419: mandoc_eos(man->last->string, strlen(man->last->string)))
1.77 schwarze 420: man->last->flags |= NODE_EOS;
1.1 kristaps 421:
1.11 schwarze 422: /*
1.95 schwarze 423: * If no arguments are specified and this is MAN_ESCOPED (i.e.,
1.11 schwarze 424: * next-line scoped), then set our mode to indicate that we're
425: * waiting for terms to load into our context.
426: */
427:
1.95 schwarze 428: if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) {
1.38 schwarze 429: man->flags |= MAN_ELINE;
1.53 schwarze 430: return;
1.11 schwarze 431: }
1.31 schwarze 432:
1.63 schwarze 433: assert(man->last->type != ROFFT_ROOT);
1.67 schwarze 434: man->next = ROFF_NEXT_SIBLING;
1.45 schwarze 435:
1.75 schwarze 436: /* Rewind our element scope. */
1.1 kristaps 437:
1.38 schwarze 438: for ( ; man->last; man->last = man->last->parent) {
1.104 schwarze 439: man->last->flags |= NODE_VALID;
1.38 schwarze 440: if (man->last == n)
1.6 schwarze 441: break;
442: }
1.95 schwarze 443:
444: /* Rewind next-line scoped ancestors, if any. */
445:
446: if (man_macro(tok)->flags & MAN_ESCOPED)
447: man_descope(man, line, ppos, NULL);
1.6 schwarze 448: }
1.1 kristaps 449:
1.53 schwarze 450: void
1.71 schwarze 451: man_endparse(struct roff_man *man)
1.6 schwarze 452: {
1.100 schwarze 453: man_unscope(man, man->meta.first);
1.6 schwarze 454: }
1.1 kristaps 455:
1.29 schwarze 456: static int
1.67 schwarze 457: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 458: {
459: char *start;
460:
461: assert(*pos);
462: *v = start = buf + *pos;
463: assert(' ' != *start);
464:
465: if ('\0' == *start)
1.74 schwarze 466: return 0;
1.29 schwarze 467:
1.99 schwarze 468: *v = roff_getarg(man->roff, v, line, pos);
1.74 schwarze 469: return 1;
1.29 schwarze 470: }
![[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